@PublicApi @ExportPackage
Package com.yahoo.metrics.simple
A metrics API with declarable metric, and also an implementation of the
JDisc Metrics API where the newest state is made continously available.
Users should have an instance of MetricReceiver
injected in the constructor where needed, then declare metrics as instances
of Counter
and
Gauge
using
MetricReceiver.declareCounter(String)
,
MetricReceiver.declareCounter(String, Point)
,
MetricReceiver.declareGauge(String)
,
MetricReceiver.declareGauge(String, Point)
, or
MetricReceiver.declareGauge(String, java.util.Optional, MetricSettings)
.
Clients input data through the API in MetricReceiver
,
while the internal work is done by MetricAggregator
.
Initialization is done top-down from MetricManager
.
The link between calls to MetricReceiver and MetricAggregator is the role of
MetricUpdater
.
- Author:
- Steinar Knutsen
-
Class Summary Class Description Bucket An aggregation of data which is only written to from a single thread.Counter A counter metric.Gauge A gauge metric, i.e.Identifier The name of the metric and its n-dimensional position.Measurement Wrapper class for the actually measured value.MetricManager This is the coordinating class owning the executor and the top level objects for measured metrics.MetricReceiver The reception point for measurements.MetricReceiver.MockReceiver MetricSettings All information needed for creating any extra data structures associated with a single metric, outside of its basic type.MetricSettings.Builder A builder for the immutable MetricSettings instances.Point An efficiently comparable point in a sparse vector space.PointBuilder Single-use builder for the immutable Point instances used to set dimensions for a metric.Sample A single metric measurement and all the meta data needed to route it correctly.UnitTestSetup Common code for running unit tests of simplemetricsUntypedMetric A gauge or a counter or...Value Wrapper for dimension values. -
Enum Summary Enum Description PointBuilder.Discriminator UntypedMetric.AssumedType Value.Discriminator Marker for the type of the contained value of a Value instance.