Prometheus Go client library
This library requires Go1.17 or later.
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
clint_golang community is also present on the CNCF Slack
For Maintainers: Release Process
To cut a minor version:
- Create a new branch
release-<major>.<minor>on top of the
maincommit you want to cut the version from and push it.
- Create a new branch on top of the release branch, e.g.
- Change the
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> / <date>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. /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.