usermetric

Documentation

Overview

Package usermetric provides a container and handler for user-facing metrics.

Index

• func Handler(w http.ResponseWriter, r *http.Request)
• func NewMultiLabelMap[T comparable](name string, promType, helpText string) *metrics.MultiLabelMap[T]
• type Gauge
  • func NewGauge(name, help string) *Gauge
  • func (g *Gauge) Set(v float64)
  • func (g *Gauge) String() string
  • func (g *Gauge) WritePrometheus(w io.Writer, name string)

Functions

func Handler

func Handler(w http.ResponseWriter, r *http.Request)

Handler returns a varz.Handler that serves the userfacing expvar contained in this package.

func NewMultiLabelMap

func NewMultiLabelMap[T comparable](name string, promType, helpText string) *metrics.MultiLabelMap[T]

NewMultiLabelMap creates and register a new MultiLabelMap[T] variable with the given name and returns it. The variable is registered with the userfacing metrics package.

Note that usermetric are not protected against duplicate metrics name. It is the caller's responsibility to ensure that the name is unique.

Types

type Gauge

type Gauge struct {
	// contains filtered or unexported fields
}

Gauge is a gauge metric with no labels.

func NewGauge

func NewGauge(name, help string) *Gauge

NewGauge creates and register a new gauge metric with the given name and help text.

func (*Gauge) Set

func (g *Gauge) Set(v float64)

Set sets the gauge to the given value.

func (*Gauge) String

func (g *Gauge) String() string

String returns the string of the underlying expvar.Float. This satisfies the expvar.Var interface.

func (*Gauge) WritePrometheus

func (g *Gauge) WritePrometheus(w io.Writer, name string)

WritePrometheus writes the gauge metric in Prometheus format to the given writer. This satisfies the varz.PrometheusWriter interface.