Prometheus Go client library
This library requires Go1.7 or later.
Important note about releases, versioning, tagging, and stability
While our goal is to follow Semantic Versioning, this repository is still pre-1.0.0. To quote the Semantic Versioning spec: “Anything may change at any time. The public API should not be considered stable.” We know that this is at odds with the widespread use of this library. However, just declaring something 1.0.0 doesn't make it 1.0.0. Instead, we are working towards a 1.0.0 release that actually deserves its major version number.
Having said that, we aim for always keeping the tip of master in a workable state. We occasionally tag versions and track their changes in CHANGELOG.md, but this happens mostly to keep dependency management tools happy and to give people a handle they can talk about easily. In particular, all commits in the master branch have passed the same testing and reviewing. There is no QA process in place that would render tagged commits more stable or better tested than others.
There is a plan behind the current (pre-1.0.0) versioning, though:
- v0.9 is the “production release”, currently tracked in the master branch. “Patch” releases will usually be just bug fixes, indeed, but important new features that do not require invasive code changes might also be included in those. We do not plan any breaking changes from one v0.9.x release to any later v0.9.y release, but nothing is guaranteed. Since the master branch will eventually be switched over to track the upcoming v0.10 (see below), we recommend to tell your dependency management tool of choice to use the latest v0.9.x release, at least for your production software. In that way, you should get bug fixes and non-invasive, low-risk new features without the need to change anything on your part.
- v0.10 is a planned release that will have a lot of breaking changes (despite being only a “minor” release in the Semantic Versioning terminology, but as said, pre-1.0.0 means nothing is guaranteed). Essentially, we have been piling up feature requests that require breaking changes for a while, and they are all collected in the v0.10 milestone. Since there will be so many breaking changes, the development for v0.10 is currently not happening in the master branch, but in the dev-0.10 branch. It will violently change for a while, and it will definitely be in a non-working state now and then. It should only be used for sneak-peaks and discussions of the new features and designs.
- Once v0.10 is ready for real-life use, it will be merged into the master branch (which is the reason why you should lock your dependency management tool to v0.9.x and only migrate to v0.10 when both you and v0.10 are ready for it). In the ideal case, v0.10 will be the basis for the future v1.0 release, but we cannot provide an ETA at this time.
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
Package api provides clients for the HTTP APIs.
|Package api provides clients for the HTTP APIs.|
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/|
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.|
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.|
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.|
Package promauto provides constructors for the usual Prometheus metrics that return them already registered with the global registry (prometheus.DefaultRegisterer).
|Package promauto provides constructors for the usual Prometheus metrics that return them already registered with the global registry (prometheus.DefaultRegisterer).|
Package promhttp provides tooling around HTTP servers and clients.
|Package promhttp provides tooling around HTTP servers and clients.|
Package push provides functions to push metrics to a Pushgateway.
|Package push provides functions to push metrics to a Pushgateway.|
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.|