metrics

Metrics Package

The metrics package contains standard drivers for opentracing, profiling and metrics.You can enable this in your appplication by calling metrics.Setup(). This will start the metric handler defined in the METRICS_HANDLER environment variable. The default is null which is a no-op handler.

METRICS_HANDLER env	Description	Supports Traces	Supports Span Events	Supports Profiling
OTLP	OTLP Exporter protocol. Supported by various external providers including New Relic, Signoz, Grafana and more	✅	✅	❌ (but it can through pyroscope, by specifying the PYROSCOPE_ENDPOINT enviornment variable)
Jaeger	Jaeger Client Clibrary, will soon be deprecated in favor of OTLP exports to jaeger as per this deprecation notice	✅	✅	❌ (but it can through pyroscope, by specifying the PYROSCOPE_ENDPOINT enviornment variable)

OTLP

We do our best to support enviornment variables specified in the Otel Spec and have added a few of our own. Key ones to note are:

Jaeger

Pass in the JAEGER_ENDPOINT enviornment variable

Pyroscope

Pass in the PYROSCOPE_ENDPOINT environment variable

Metrics Endpoint

The metrics endpoint is exposed on /metrics on port 8080 by default and is compatible with prometheus. The following options control the metrics endpoint:

Enviornment Variable	Description	Default
METRICS_PORT_ENABLED	Wether or not to enable the metrics endpoint.	true
METRICS_PORT	Port to serve metrics on.	8080
METRICS_PATH	Path to serve metrics on	/metrics

Note: this server failing to bind to METRICS_PORT will not cause the application to fail to start. The error will be logged.