metrics

Documentation

Index

• type MultiGatherer
  • func NewMultiGatherer() MultiGatherer
• type OptionalGatherer
  • func NewOptionalGatherer() OptionalGatherer

Types

type MultiGatherer

type MultiGatherer interface {
	prometheus.Gatherer

	// Register adds the outputs of [gatherer] to the results of future calls to
	// Gather with the provided [namespace] added to the metrics.
	Register(namespace string, gatherer prometheus.Gatherer) error
}

MultiGatherer extends the Gatherer interface by allowing additional gatherers to be registered.

func NewMultiGatherer

func NewMultiGatherer() MultiGatherer

type OptionalGatherer

type OptionalGatherer interface {
	prometheus.Gatherer

	// Register the provided gatherer. If a gatherer was previously registered,
	// an error will be returned.
	Register(gatherer prometheus.Gatherer) error
}

OptionalGatherer extends the Gatherer interface by allowing the optional registration of a single gatherer. If no gatherer is registered, Gather will return no metrics and no error. If a gatherer is registered, Gather will return the results of calling Gather on the provided gatherer.

func NewOptionalGatherer

func NewOptionalGatherer() OptionalGatherer