package
19.2.12+incompatible
Repository: https://github.com/cockroachdb/cockroach-gen.git
Documentation: pkg.go.dev

# Functions

MakeGraphiteExporter returns an initialized graphite exporter.
MakePrometheusExporter returns an initialized prometheus exporter.
NewCounter creates a counter.
NewFunctionalGauge creates a Gauge metric whose value is determined when asked for by calling the provided function.
NewGauge creates a Gauge.
NewGaugeFloat64 creates a GaugeFloat64.
NewHistogram initializes a given Histogram.
NewLatency is a convenience function which returns a histogram with suitable defaults for latency tracking.
NewRate creates an EWMA rate on the given timescale.
NewRegistry creates a new Registry.
TestingSetNow changes the clock used by the metric system.

# Constants

MaxLatency is the maximum value tracked in latency histograms.
TestSampleInterval is passed to histograms during tests which don't want to concern themselves with supplying a "correct" interval.
BYTES expresses that the metric's measurement is in bytes.
CONST expresses that the metric's measurement is a constant value.
COUNT expresses that the metric's measurement is a count.
NANOSECONDS expresses that the metric's measurement is in nanoseconds.
PERCENT expresses that the metric's measurement is a percentage value.
SECONDS expresses that the metric's measurement is in seconds.
TIMESTAMP_NS expresses that the metric's measurement is a time since the Unix epoch in nanoseconds.
TIMESTAMP_SEC expresses that the metric's measurement is a time since the Unix epoch in seconds.
UNSET expresses that the metric's DisplayUnit wasn't explicitly set.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

A Counter holds a single mutable atomic value.
A Gauge atomically stores a single integer value.
A GaugeFloat64 atomically stores a single float64 value.
GraphiteExporter scrapes PrometheusExporter for metrics and pushes them to a Graphite or Carbon server.
A Histogram collects observed values by keeping bucketed counts.
metric.LabelPair is a proxy for io.prometheus.client.LabelPair.
Metadata holds metadata about a metric.
PrometheusExporter contains a map of metric families (a metric with multiple labels).
A Rate is a exponential weighted moving average.
A Registry is a list of metrics.

# Interfaces

Iterable provides a method for synchronized access to interior objects.
PrometheusExportable is the standard interface for an individual metric that can be exported to prometheus.
Struct can be implemented by the types of members of a metric container so that the members get automatically registered.

# Type aliases

DisplayUnit describes how the metric's units should be displayed in charts.