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.
Instrumenting applications
The
prometheus directory
contains the instrumentation library. See the
best practices section of the
Prometheus documentation 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.
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
|
|
|
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. |
|
Package prometheus provides metrics primitives to instrument code for monitoring.
|
Package prometheus provides metrics primitives to instrument code for monitoring. |
|
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. |
|
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. |