metrics

Documentation

Index

• func RegisterGatherer(g promcli.Gatherer)
• func Start(mux *http.ServeMux, options ...Option) error
• func Stop()
• type Option
  • func WithExporterDisabled(disabled bool) Option
  • func WithPeriod(period time.Duration) Option
  • func WithServiceName(name string) Option

Functions

func RegisterGatherer

func RegisterGatherer(g promcli.Gatherer)

func Start

func Start(mux *http.ServeMux, options ...Option) error

Start metrics exporter.

func Stop

func Stop()

Stop metrics exporter.

Types

type Option

type Option func(*metrics) error

Option represents an option which can be applied to metrics.

func WithExporterDisabled

func WithExporterDisabled(disabled bool) Option

WithExporterDisabled can be used to disable the metrics exporter.

func WithPeriod

func WithPeriod(period time.Duration) Option

WithPeriod sets the internal metrics collection period.

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the service name reported for metrics.