metrics

package

v0.5.1 Latest Latest Go to latest Published: Mar 28, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Metrics struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Metrics implements collecting, caching and processing of raw metrics.

func NewMetrics(opts Options) (*Metrics, error)

NewMetrics creates a new instance for metrics collecting and processing.

func (m *Metrics) Gather() ([]*model.MetricFamily, error)

Gather is our prometheus.Gatherer interface for proxying metrics.

func (m *Metrics) Start() error

Start starts metrics collection and processing.

func (m *Metrics) Stop()

Stop stops metrics collection and processing.

type Options struct {
	// PollInterval is the interval for polling raw metrics.
	PollInterval time.Duration
}

Options describes options for metrics collection and processing.