client_golang/prometheus/metric.go

// Copyright (c) 2013, Prometheus Team
// All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package prometheus

import (
	"encoding/json"

	dto "github.com/prometheus/client_model/go"
)

// A Metric is something that can be exposed via the registry framework.
type Metric interface {
	// Produce a JSON representation of the metric.
	json.Marshaler
	// Reset removes any stored values associated with a given labelset.
	Reset(labels map[string]string)
	// Reset the parent metrics and delete all child metrics.
	ResetAll()
	// Produce a human-consumable representation of the metric.
	String() string
	// dumpChildren populates the child metrics of the given family.
	dumpChildren(*dto.MetricFamily)
}