Categorygithub.com/dylanoy/metrics
modulepackage
1.3.1
Repository: https://github.com/dylanoy/metrics.git
Documentation: pkg.go.dev

# README

net/metrics GoDoc Build Status Coverage Status

Fast, Prometheus- and Graphite-compatible metrics.

Work in Progress

# Packages

Package bucket provides utility functions for constructing and merging histogram buckets.
Package push integrates go.uber.org/net/metrics with push-based telemetry systems like Graphite and M3.
Package tallypush integrates go.uber.org/net/metrics with push-based StatsD and M3 systems.

# Functions

IsValidName checks whether the supplied string is a valid metric and tag name in both Prometheus and Tally.
IsValidTagValue checks whether the supplied string is a valid tag value in both Prometheus and Tally.
New constructs a root.

# Constants

Placeholders for empty tag names and values.
Placeholders for empty tag names and values.
Version is the current semantic version, exported for runtime compatibility checks.

# Structs

A Counter is a monotonically increasing value, like a car's odometer.
A CounterVector is a collection of Counters that share a name and some constant tags, but also have a consistent set of variable tags.
A Gauge is a point-in-time measurement, like a car's speedometer.
A GaugeVector is a collection of Gauges that share a name and some constant tags, but also have a consistent set of variable tags.
A Histogram approximates a distribution of values.
A HistogramSnapshot is a point-in-time view of the state of a Histogram.
A HistogramSpec configures Histograms and HistogramVectors.
A HistogramVector is a collection of Histograms that share a name and some constant tags, but also have a consistent set of variable tags.
A Root is a collection of tagged metrics that can be exposed via in-memory snapshots, push-based telemetry systems, or a Prometheus-compatible HTTP handler.
A RootSnapshot exposes all the metrics contained in a Root and all its Scopes.
A Scope is a collection of tagged metrics.
A Snapshot is a point-in-time view of the state of any non-histogram metric.
A Spec configures Counters, Gauges, CounterVectors, and GaugeVectors.

# Interfaces

An Option configures a root.

# Type aliases

Tags describe the dimensions of a metric.