Prometheus Go client library
This library requires Go1.9 or later. The minimum required patch releases for older Go versions are Go1.9.7 and Go1.10.3.
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. The v2 development happens in a separate branch for the time being. v2 releases off that branch will happen once sufficient stability is reached. In view of the widespread use of this repository, v1 and v2 will coexist for a while to enable a convenient transition.
contains simple examples of instrumented code.
Client for the Prometheus HTTP API
model packages has been moved to
text packages are now contained in
Contributing and community
|api||Package api provides clients for the HTTP APIs.|
|api/prometheus/v1||Package v1 provides bindings to the Prometheus HTTP API v1: http://prometheus.io/docs/querying/api/|
|examples/random||A simple example exposing fictional RPC latencies with different types of random distributions (uniform, normal, and exponential) as Prometheus metrics.|
|examples/simple||A minimal example of how to include Prometheus instrumentation.|
|prometheus||Package prometheus is the core instrumentation package.|
|prometheus/graphite||Package graphite provides a bridge to push Prometheus metrics to a Graphite server.|
|prometheus/promauto||Package promauto provides alternative constructors for the fundamental Prometheus metric types and their …Vec and …Func variants.|
|prometheus/promhttp||Package promhttp provides tooling around HTTP servers and clients.|
|prometheus/push||Package push provides functions to push metrics to a Pushgateway.|
|prometheus/testutil||Package testutil provides helpers to test code using the prometheus package of client_golang.|
|prometheus/testutil/promlint||Package promlint provides a linter for Prometheus metrics.|