prometheus

Documentation

Index

• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Append(m Marshaller) error
• type Marshaller
• type Metric

Types

type Encoder

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

An Encoder writes Prometheus samples to the writer

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder creates a new Prometheus encoder.

func (*Encoder) Append

func (e *Encoder) Append(m Marshaller) error

Append marshals a Marshaller and appends it to the encoder's buffer.

type Marshaller

type Marshaller interface {
	PrometheusMetric() []Metric
}

A Marshaller can be marshalled into Prometheus samples

type Metric

type Metric struct {
	Name      string
	Labels    map[string]any
	Value     float64
	Timestamp time.Time
}

A Metric is a Prometheus metric.