Text of pkg.go.dev › github.com › prometheus › client_golang as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

client_golang module - github.com/prometheus/client_golang - Go Packages

README ¶ Prometheus Go client library This is the Go client library for Prometheus . It has two separate parts, one for instrumenting application code, and one for creating clients that talk to the Prometheus HTTP API. Version Compatibility This library supports the two most recent major releases of Go. While it may function with older versions, we only provide fixes and support for the currently supported Go releases. [!NOTE] See our Release Process for details on compatibility and support policies.

Important note about releases and stability This repository generally follows Semantic Versioning . However, the API client in prometheus/client_golang/api/… is still considered experimental. Breaking changes of the API client will not trigger a new major release. The same is true for selected other new features explicitly marked as EXPERIMENTAL in CHANGELOG.md. Features that require breaking changes in the stable parts of the repository are being batched up and tracked in the v2 milestone , but plans for further development of v2 at the moment.

NOTE: The initial v2 attempt is in a separate branch . We also started experimenting on a new prometheus.V2.* APIs in the 1.x's V2 struct . Help wanted! Instrumenting applications The prometheus directory contains the instrumentation library. See the guide on the Prometheus website to learn more about instrumenting applications. The examples directory contains simple examples of instrumented code. Pushing metrics via OpenTelemetry OTLP Applications instrumented with client_golang can also export their metrics via the OpenTelemetry OTLP push protocol without re-instrumenting against a different metric API.

The go.opentelemetry.io/contrib/bridges/prometheus module wraps a prometheus.Registry as an OpenTelemetry metric producer, which an OTLP exporter (HTTP or gRPC) can then push to an OTel collector or OTLP-accepting backend. This is useful for batch jobs or environments where pull-based /metrics scraping is not an option. Pull-based collection via promhttp remains the recommended default for reliability, central discovery, and failover.

The bridge is intended as an additional option, not a replacement. See the bridge's Go reference and source for setup details. Client for the Prometheus HTTP API The api/prometheus directory contains the client for the Prometheus HTTP API . It allows you to write Go applications that query time series data from a Prometheus server. It is still in alpha stage. Where is model , extraction , and text ? The model packages has been moved to prometheus/common/model .

The extraction and text packages are now contained in prometheus/common/expfmt . Contributing and community See the contributing guidelines and the Community section of the homepage. client_golang community is also present on the CNCF Slack #prometheus-client_golang . Directories ¶ Path Synopsis api Package api provides clients for the HTTP APIs. Package api provides clients for the HTTP APIs. prometheus/v1 Package v1 provides bindings to the Prometheus HTTP API v1: http://prometheus.io/docs/querying/api/ Package v1 provides bindings to the Prometheus HTTP API v1: http://prometheus.io/docs/querying/api/ examples createdtimestamps command customlabels command exemplars command gocollector command A minimal example of how to include Prometheus instrumentation.

A minimal example of how to include Prometheus instrumentation. middleware command middleware/httpmiddleware Package httpmiddleware is adapted from https://github.com/bwplotka/correlator/tree/main/examples/observability/ping/pkg/httpinstrumentation Package httpmiddleware is adapted from https://github.com/bwplotka/correlator/tree/main/examples/observability/ping/pkg/httpinstrumentation nativehistogram command A simple example of how to use native histograms.

A simple example of how to use native histograms. random command A simple example exposing fictional RPC latencies with different types of random distributions (uniform, normal, and exponential) as Prometheus metrics. A simple example exposing fictional RPC latencies with different types of random distributions (uniform, normal, and exponential) as Prometheus metrics. simple command A minimal example of exposing Prometheus metrics from a Go application.

A minimal example of exposing Prometheus metrics from a Go application. versioncollector command A minimal example of how to include Prometheus instrumentation. A minimal example of how to include Prometheus instrumentation. exp module internal github.com/golang/gddo/httputil github.com/golang/gddo/httputil/header Package header provides functions for parsing HTTP headers. Package header provides functions for parsing HTTP headers. prometheus Package prometheus is the core instrumentation package.

Package prometheus is the core instrumentation package. collectors Package collectors provides implementations of prometheus.Collector to conveniently collect process and Go-related metrics. Package collectors provides implementations of prometheus.Collector to conveniently collect process and Go-related metrics. collectors/version graphite Package graphite provides a bridge to push Prometheus metrics to a Graphite server.

Package graphite provides a bridge to push Prometheus metrics to a Graphite server. internal promauto Package promauto provides alternative constructors for the fundamental Prometheus metric types and their …Vec and …Func variants. Package promauto provides alternative constructors for the fundamental Prometheus metric types and their …Vec and …Func variants. promhttp Package promhttp provides tooling around HTTP servers and clients.

Package promhttp provides tooling around HTTP servers and clients. promhttp/internal promhttp/zstd Package zstd activates support for zstd compression. Package zstd activates support for zstd compression. push Package push provides functions to push metrics to a Pushgateway. Package push provides functions to push metrics to a Pushgateway. testutil Package testutil provides helpers to test code using the prometheus package of client_golang.

Package testutil provides helpers to test code using the prometheus package of client_golang. testutil/promlint Package promlint provides a linter for Prometheus metrics. Package promlint provides a linter for Prometheus metrics. testutil/promlint/validations tutorials whatsup module Click to show internal directories. Click to hide internal directories. go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.

Learn more.