metrics

README

metrics

Introduction:

• https://opentelemetry.io/docs/languages/go/instrumentation/

Clients:

• https://github.com/open-telemetry/opentelemetry-go
• https://github.com/prometheus/client_golang
• https://github.com/VictoriaMetrics/metrics

Onboarding:

• https://www.timescale.com/blog/four-types-prometheus-metrics-to-collect/
• https://blog.pvincent.io/2017/12/prometheus-blog-series-part-1-metrics-and-labels/
• https://pierrevincent.github.io/2017/12/prometheus-blog-series-part-2-metric-types/
• https://pierrevincent.github.io/2017/12/prometheus-blog-series-part-3-exposing-and-collecting-metrics/
• https://pierrevincent.github.io/2017/12/prometheus-blog-series-part-4-instrumenting-code-in-go-and-java/
• https://developers.soundcloud.com/blog/prometheus-monitoring-at-soundcloud

Best practices:

• https://prometheus.io/docs/practices/naming/

See also:

• https://pkg.go.dev/github.com/prometheus/client_golang@v1.17.0/prometheus#NewRegistry
• https://pkg.go.dev/go.opentelemetry.io/otel/exporters/prometheus@v0.44.0#New
• https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric@v1.21.0#NewMeterProvider
• https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric@v1.21.0#MeterProvider.Meter
• https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/runtime@v0.46.1#Start

Documentation

Overview

Package metrics implements a very opinionated take on metrics.

Please consider this more like an example rather than a standard to follow.

Index

• Constants
• Variables
• type MetricsServer
  • func New(name, addr string) (metricsServer *MetricsServer, err error)
  • func (ms *MetricsServer) Float64Histogram(name string, description string, uom string, bucketBounds ...float64) metric.Float64Histogram
  • func (ms *MetricsServer) ListenAndServe() error
  • func (ms *MetricsServer) Shutdown(ctx context.Context) error

Constants

const (
	UomMicroseconds = "us"
)

Variables

var BucketsRequestDuration = []float64{
	0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1.0, 2.5, 5.0, 10.0, 30.0, 60.0,
}

Types

type MetricsServer

type MetricsServer struct {
	// contains filtered or unexported fields
}

func New

func New(name, addr string) (metricsServer *MetricsServer, err error)

func (*MetricsServer) Float64Histogram

func (ms *MetricsServer) Float64Histogram(
	name string,
	description string,
	uom string,
	bucketBounds ...float64,
) metric.Float64Histogram

Float64Histogram returns a float64 histogram with given name and parameters.

Once created it's cached and reused further on. All subsequent calls to this method that use the same name will retrieve already created histogram from the cache.

It is thread-safe.

See also: https://pkg.go.dev/go.opentelemetry.io/otel/metric@v1.21.0#Meter.Float64Histogram

func (*MetricsServer) ListenAndServe

func (ms *MetricsServer) ListenAndServe() error

func (*MetricsServer) Shutdown

func (ms *MetricsServer) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the server without interrupting any active connections.