public interface MetricsContext
In some cases it is possible to have a separate MetricsContext for each instance of a component, for instance on the server side a possible usecase it to gather metrics for every other peer.
Contexts are organized in a hierarchy.
Modifier and Type | Interface and Description |
---|---|
static class |
MetricsContext.DetailLevel |
Modifier and Type | Method and Description |
---|---|
MetricsContext |
getContext(String name)
Returns a sub context.
|
Counter |
getCounter(String name)
Returns a counter.
|
Summary |
getSummary(String name,
MetricsContext.DetailLevel detailLevel)
Returns a summary.
|
SummarySet |
getSummarySet(String name,
MetricsContext.DetailLevel detailLevel)
Returns a set of summaries.
|
void |
registerGauge(String name,
Gauge gauge)
Registers an user provided
Gauge which will be called by the
MetricsProvider in order to sample an integer value. |
void |
unregisterGauge(String name)
Unregisters the user provided
Gauge bound to the given name. |
MetricsContext getContext(String name)
name
- the name of the subcontextCounter getCounter(String name)
name
- void registerGauge(String name, Gauge gauge)
Gauge
which will be called by the
MetricsProvider in order to sample an integer value.
If another Gauge was already registered the new one will
take its place.
Registering a null callback is not allowed.name
- unique name of the Gauge in this contextgauge
- the implementation of the Gaugevoid unregisterGauge(String name)
Gauge
bound to the given name.name
- unique name of the Gauge in this contextSummary getSummary(String name, MetricsContext.DetailLevel detailLevel)
name
- detailLevel
- SummarySet getSummarySet(String name, MetricsContext.DetailLevel detailLevel)
name
- detailLevel
- Copyright © 2008–2021 The Apache Software Foundation. All rights reserved.