metrics

Documentation

Overview

Package metrics provides a simple interface for collecting metrics.

Index

• Variables
• type Collector
• type Gatherer
• type Metric
• type Monitor
• type Probe
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Handler() http.Handler

Variables

var (
	// DefaultRegistry is a default prometheus registry.
	DefaultRegistry = NewRegistry()

	// DefaultRegisterer is a default prometheus registerer.
	DefaultRegisterer prometheus.Registerer = DefaultRegistry

	// DefaultGatherer is a default prometheus gatherer.
	DefaultGatherer prometheus.Gatherer = DefaultRegistry
)

Types

type Collector

type Collector interface {
	// Collect ...
	Collect(ch chan<- Metric)
}

Collector is a type that can collect metrics.

type Gatherer

type Gatherer interface {
	// Gather ...
	Gather(collector Collector)
}

Gatherer is a type that can gather metrics.

type Metric

type Metric interface {
	// Write ...
	Write(m Monitor) error
}

Metric is a type that can be collected.

type Monitor

type Monitor interface {
	// Write ...
	Write(m Metric) error
}

Monitor is a type that can monitor metrics.

type Probe

type Probe[K, V any] interface {
	// Do ...
	Do(ctx context.Context, monitor Monitor) error

	Collector
}

Probe is a type that can probe metrics.

type Registry

type Registry struct {
	*prometheus.Registry
}

Registry is a prometheus registry.

func NewRegistry

func NewRegistry() *Registry

NewRegistry is a constructor for Registry.

func (*Registry) Handler

func (r *Registry) Handler() http.Handler

Handler returns a HTTP handler for this registry. Should be registered at "/metrics".