9dc7358869
* allow exposing meta information for registered metrics New public method `ExposeMetadata` allows enabling exposition of dummy meta-info for all exposed metrics across all Sets. This feature is needed to improve compatibility with 3rd-party scrapers that require meta information to be present. This commit doesn't update exposition of default system/process metrics to keep the list of changes small. This change should be added in a follow-up commit. https://github.com/VictoriaMetrics/metrics/issues/48 * cleanup * wip * wip * wip * wip --------- Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
72 lines
1.7 KiB
Go
72 lines
1.7 KiB
Go
package metrics
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
)
|
|
|
|
// NewGauge registers and returns gauge with the given name, which calls f
|
|
// to obtain gauge value.
|
|
//
|
|
// name must be valid Prometheus-compatible metric with possible labels.
|
|
// For instance,
|
|
//
|
|
// - foo
|
|
// - foo{bar="baz"}
|
|
// - foo{bar="baz",aaa="b"}
|
|
//
|
|
// f must be safe for concurrent calls.
|
|
//
|
|
// The returned gauge is safe to use from concurrent goroutines.
|
|
//
|
|
// See also FloatCounter for working with floating-point values.
|
|
func NewGauge(name string, f func() float64) *Gauge {
|
|
return defaultSet.NewGauge(name, f)
|
|
}
|
|
|
|
// Gauge is a float64 gauge.
|
|
//
|
|
// See also Counter, which could be used as a gauge with Set and Dec calls.
|
|
type Gauge struct {
|
|
f func() float64
|
|
}
|
|
|
|
// Get returns the current value for g.
|
|
func (g *Gauge) Get() float64 {
|
|
return g.f()
|
|
}
|
|
|
|
func (g *Gauge) marshalTo(prefix string, w io.Writer) {
|
|
v := g.f()
|
|
if float64(int64(v)) == v {
|
|
// Marshal integer values without scientific notation
|
|
fmt.Fprintf(w, "%s %d\n", prefix, int64(v))
|
|
} else {
|
|
fmt.Fprintf(w, "%s %g\n", prefix, v)
|
|
}
|
|
}
|
|
|
|
func (g *Gauge) metricType() string {
|
|
return "gauge"
|
|
}
|
|
|
|
// GetOrCreateGauge returns registered gauge with the given name
|
|
// or creates new gauge if the registry doesn't contain gauge with
|
|
// the given name.
|
|
//
|
|
// name must be valid Prometheus-compatible metric with possible labels.
|
|
// For instance,
|
|
//
|
|
// - foo
|
|
// - foo{bar="baz"}
|
|
// - foo{bar="baz",aaa="b"}
|
|
//
|
|
// The returned gauge is safe to use from concurrent goroutines.
|
|
//
|
|
// Performance tip: prefer NewGauge instead of GetOrCreateGauge.
|
|
//
|
|
// See also FloatCounter for working with floating-point values.
|
|
func GetOrCreateGauge(name string, f func() float64) *Gauge {
|
|
return defaultSet.GetOrCreateGauge(name, f)
|
|
}
|