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.

func RegisterGatherer(g promcli.Gatherer)

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

Start metrics exporter.

func Stop()

Stop metrics exporter.

type Option func(*metrics) error

Option represents an option which can be applied to metrics.

func WithExporterDisabled(disabled bool) Option

WithExporterDisabled can be used to disable the metrics exporter.

func WithPeriod(period time.Duration) Option

WithPeriod sets the internal metrics collection period.

func WithServiceName(name string) Option

WithServiceName sets the service name reported for metrics.