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.
This library requires Go1.20 or later.
The library mandates the use of Go1.20 or subsequent versions. While it has demonstrated functionality with versions as old as Go 1.17, our commitment remains to offer support and rectifications for only the most recent three major releases.
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.
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.
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.
For Maintainers: Release Process
To cut a minor version:
- Create a new branch
release-<major>.<minor>on top of themaincommit you want to cut the version from and push it. - Create a new branch on top of the release branch, e.g.
<yourname>/cut-<major>.<minor>.<patch>, - Change the
VERSIONfile. - Update
CHANGELOG(only user-impacting changes to mention). - Create PR, and get it reviewed.
- Once merged, create a release with the
release-<major>.<minor>tag on GitHub with the<version>title. - Announce on the prometheus-announce mailing list, slack and Twitter.
- Merge the release branch back to the
mainusing the "merge without squashing" approach (!).
NOTE: In case of merge conflicts, you can checkout the release branch in a new branch, e.g.
<yourname>/resolve-conflicts, fix the merge problems there, and then do a PR into main from the new branch. In that way, you still get all the commits in the release branch back intomain, but leave the release branch alone.
To cut the patch version:
- Create a branch on top of the release branch you want to use.
- Cherry-pick the fixes from the
mainbranch (or add new commits) to fix critical bugs for that patch release. - Follow steps 3-8 as above.
Directories
¶
| Path | Synopsis |
|---|---|
|
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
|
|
|
gocollector
A minimal example of how to include Prometheus instrumentation.
|
A minimal example of how to include Prometheus instrumentation. |
|
random
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
A minimal example of how to include Prometheus instrumentation.
|
A minimal example of how to include Prometheus instrumentation. |
|
versioncollector
A minimal example of how to include Prometheus instrumentation.
|
A minimal example of how to include Prometheus instrumentation. |
|
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. |
|
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. |
|
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. |
|
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. |