README
¶
Overview
This is the Prometheus Go client library. It provides several distinct functions, and there is separate documentation for each respective component. You will want to select the appropriate topic below to continue your journey:
-
See the exposition library if you want to export metrics to a Prometheus server or pushgateway
-
See the consumption library if you want to process metrics exported by a Prometheus client. (The Prometheus server is using that library.)
Getting Started
- The source code is periodically indexed: Go Exposition Client.
- All of the core developers are accessible via the Prometheus Developers Mailinglist.
Testing
$ go test ./...
Continuous Integration
Contributing
See the contributing guidelines.
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/bitbucket.org/ww/goautoneg
HTTP Content-Type Autonegotiation.
|
HTTP Content-Type Autonegotiation. |
|
_workspace/src/github.com/beorn7/perks/quantile
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds.
|
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds. |
|
_workspace/src/github.com/golang/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/github.com/matttproud/golang_protobuf_extensions/pbutil
Package pbutil provides record length-delimited Protocol Buffer streaming.
|
Package pbutil provides record length-delimited Protocol Buffer streaming. |
|
_workspace/src/github.com/prometheus/client_model/go
Package io_prometheus_client is a generated protocol buffer package.
|
Package io_prometheus_client is a generated protocol buffer package. |
|
_workspace/src/github.com/prometheus/procfs
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.
|
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc. |
|
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 extraction decodes Prometheus clients' data streams for consumers.
|
Package extraction decodes Prometheus clients' data streams for consumers. |
|
Package model contains core representation of Prometheus client primitives.
|
Package model contains core representation of Prometheus client primitives. |
|
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface.
|
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface. |
|
Package text contains helper functions to parse and create text-based exchange formats.
|
Package text contains helper functions to parse and create text-based exchange formats. |
Click to show internal directories.
Click to hide internal directories.