Crate prometheus [−] [src]

Protocol buffers format of metrics.

Create a HistogramOpts

Create labes with specify name-value pairs.

Create an Opts.

Create a Counter and register to default registry.

Create a CounterVec and register to default registry.

Create a Gauge and register to default registry.

Create a GaugeVec and register to default registry.

Create a Histogram and register to default registry.

Create a HistogramVec and register to default registry.

Counter is a Metric that represents a single numerical value that only ever goes up.

Desc is the descriptor used by every Prometheus Metric. It is essentially the immutable meta-data of a Metric. The normal Metric implementations included in this package manage their Desc under the hood.

Gauge is a Metric that represents a single numerical value that can arbitrarily go up and down.

A Histogram counts individual observations from an event or sample stream in configurable buckets. Similar to a summary, it also provides a sum of observations and an observation count.

HistogramOpts bundles the options for creating a Histogram metric. It is mandatory to set Name and Help to a non-empty string. All other fields are optional and can safely be left at their zero value.

HistogramTimer represents an event being timed. When the timer goes out of scope, the duration will be observed, or call observe_duration to manually observe.

MetricVec is a Collector to bundle metrics of the same name that differ in their label values. MetricVec is usually not used directly but as a building block for implementations of vectors of a given metric type. GaugeVec, CounterVec, SummaryVec, and UntypedVec are examples already provided in this package.

Opts bundles the options for creating most Metric types.

Implementation of an Encoder that converts a MetricFamily proto message into the binary wire format of protobuf.

Registry registers Prometheus collectors, collects their metrics, and gathers them into MetricFamilies for exposition.

Implementation of an Encoder that converts a MetricFamily proto message into text format.

The error types for prometheus.

DEFAULT_BUCKETS are the default Histogram buckets. The default buckets are tailored to broadly measure the response time (in seconds) of a network service. Most likely, however, you will be required to define buckets customized to your use case.

The protocol buffer format of metric family.

The text format of metric family.

Collector is the trait that can be used to collect metrics. A Collector has to be registered for collection.

Encoder types encode metric families into an underlying wire protocol.

exponential_buckets creates count buckets, where the lowest bucket has an upper bound of start and each following buckets upper bound isfactortimes the previous buckets upper bound. The final +Inf bucket is not counted and not included in the returned slice. The returned slice is meant to be used for the Buckets field of HistogramOpts.

gather returns all MetricFamily of DEFAULT_REGISTRY.

linear_buckets creates count buckets, each width wide, where the lowest bucket has an upper bound of start. The final +Inf bucket is not counted and not included in the returned slice. The returned slice is meant to be used for the Buckets field of HistogramOpts.

register registers a new Collector to be included in metrics collection. It returns an error if the descriptors provided by the Collector are invalid or if they - in combination with descriptors of already registered Collectors - do not fulfill the consistency and uniqueness criteria described in the Desc documentation.

unregister unregisters the Collector that equals the Collector passed in as an argument. (Two Collectors are considered equal if their Describe method yields the same set of descriptors.) The function returns an error if a Collector was not registered.

CounterVec is a Collector that bundles a set of Counters that all share the same Desc, but have different values for their variable labels. This is used if you want to count the same thing partitioned by various dimensions (e.g. number of HTTP requests, partitioned by response code and method).

GaugeVec is a Collector that bundles a set of Gauges that all share the same Desc, but have different values for their variable labels. This is used if you want to count the same thing partitioned by various dimensions (e.g. number of operations queued, partitioned by user and operation type).

HistogramVec is a Collector that bundles a set of Histograms that all share the same Desc, but have different values for their variable labels. This is used if you want to count the same thing partitioned by various dimensions (e.g. HTTP request latencies, partitioned by status code and method).

A specialized Result type for prometheus.