Package org.apache.sling.commons.metrics
Interface MetricsService
-
@ProviderType public interface MetricsServiceTheMetricsServiceenables creation of various types ofMetric.
-
-
Field Summary
Fields Modifier and Type Field Description static MetricsServiceNOOPDummy variant of MetricsService which does not collect any metric
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <A> AadaptTo(Class<A> type)Adapts the service to the specified type.Countercounter(String name)Creates a newCounterand registers it under the given name.<T> Gauge<T>gauge(String name, Supplier<T> supplier)Creates a newGaugeand registers it under the given name.Histogramhistogram(String name)Creates a newHistogramand registers it under the given name.Metermeter(String name)Creates a newMeterand registers it under the given name.Timertimer(String name)Creates a newTimerand registers it under the given name.booleanunregister(String name)Unregister a metric by its name
-
-
-
Field Detail
-
NOOP
static final MetricsService NOOP
Dummy variant of MetricsService which does not collect any metric
-
-
Method Detail
-
timer
Timer timer(String name)
Creates a newTimerand registers it under the given name. If a timer with same name exists then same instance is returned- Parameters:
name- the name of the metric- Returns:
- a new
Timer
-
histogram
Histogram histogram(String name)
Creates a newHistogramand registers it under the given name. If a histogram with same name exists then same instance is returned.- Parameters:
name- the name of the metric- Returns:
- a new
Histogram
-
counter
Counter counter(String name)
Creates a newCounterand registers it under the given name. If a counter with same name exists then same instance is returned- Parameters:
name- the name of the metric- Returns:
- a new
Counter
-
meter
Meter meter(String name)
Creates a newMeterand registers it under the given name. If a meter with same name exists then same instance is returned- Parameters:
name- the name of the metric- Returns:
- a new
Meter
-
gauge
<T> Gauge<T> gauge(String name, Supplier<T> supplier)
Creates a newGaugeand registers it under the given name. If a gauge with teh same exists already the the same instance is returned.- Type Parameters:
T- the type of the metric- Parameters:
name- the name of the gaugesupplier- provides the values which are returned by the gauge- Returns:
- the gauge
-
adaptTo
<A> A adaptTo(Class<A> type)
Adapts the service to the specified type. This can be used to get instance to underlyingMetricRegistry- Type Parameters:
A- The type to which this metric is to be adapted.- Parameters:
type- Class object for the type to which this metric is to be adapted.- Returns:
- The object, of the specified type, to which this metric has been adapted or null if this metric cannot be adapted to the specified type.
-
unregister
boolean unregister(String name)
Unregister a metric by its name- Parameters:
name- the name of the metric- Returns:
- true if the metric was correctly unregistered, false otherwise.
-
-