org.forgerock.monitoring.api.instrument

Interface Meter

All Known Subinterfaces:

Counter, DistributionSummary, Gauge, TimeGauge, Timer

All Known Implementing Classes:

DropwizardTypes.DescribableCounter, DropwizardTypes.DescribableGauge, DropwizardTypes.DescribableMeter, DropwizardTypes.DescribableTimer

public interface Meter

A counter, gauge, timer, or distribution summary that results collects one or more metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Meter.Builder Fluent builder for custom meters.
static class	Meter.Id A meter is uniquely identified by its combination of name and tags.
static class	Meter.Type Custom meters may emit metrics like one of these types without implementing the corresponding interface.

Method Summary

Modifier and Type	Method and Description
static Meter.Builder	builder(String name, Meter.Type type, Iterable<Measurement> measurements)
Meter.Id	getId()
Iterable<Measurement>	measure() Get a set of measurements.

Method Detail

builder

static Meter.Builder builder(String name,
                             Meter.Type type,
                             Iterable<Measurement> measurements)

getId

Meter.Id getId()

Returns:

A unique combination of name and tags

measure

Iterable<Measurement> measure()

Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.

Returns:

The set of measurements that represents the instantaneous value of this meter.