public abstract class AbstractRegistry extends Object implements Registry
Modifier and Type | Field and Description |
---|---|
protected org.slf4j.Logger |
logger
Logger instance for the class.
|
Constructor and Description |
---|
AbstractRegistry(Clock clock)
Create a new instance.
|
AbstractRegistry(Clock clock,
RegistryConfig config)
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
Clock |
clock()
The clock used by the registry for timing events.
|
RegistryConfig |
config()
Configuration settings used for this registry.
|
Counter |
counter(Id id)
Measures the rate of some activity.
|
Id |
createId(String name)
Creates an identifier for a meter.
|
Id |
createId(String name,
Iterable<Tag> tags)
Creates an identifier for a meter.
|
DistributionSummary |
distributionSummary(Id id)
Measures the rate and variation in amount for some activity.
|
Gauge |
gauge(Id id)
Represents a value sampled from another source.
|
Meter |
get(Id id)
Returns the meter associated with a given id.
|
Iterator<Meter> |
iterator()
Iterator for traversing the set of meters in the registry.
|
protected abstract Counter |
newCounter(Id id)
Create a new counter instance for a given id.
|
protected abstract DistributionSummary |
newDistributionSummary(Id id)
Create a new distribution summary instance for a given id.
|
protected abstract Gauge |
newGauge(Id id)
Create a new gauge instance for a given id.
|
protected abstract Timer |
newTimer(Id id)
Create a new timer instance for a given id.
|
void |
register(Meter meter)
Add a custom meter to the registry.
|
Timer |
timer(Id id)
Measures the rate and time taken for short running tasks.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
collectionSize, collectionSize, counter, counter, counter, counters, createId, createId, distributionSummaries, distributionSummary, distributionSummary, distributionSummary, gauge, gauge, gauge, gauge, gauge, longTaskTimer, longTaskTimer, longTaskTimer, longTaskTimer, mapSize, mapSize, methodValue, methodValue, propagate, propagate, stream, timer, timer, timer, timers, underlying
forEach, spliterator
public AbstractRegistry(Clock clock)
clock
- Clock used for performing all timing measurements.public AbstractRegistry(Clock clock, RegistryConfig config)
clock
- Clock used for performing all timing measurements.config
- Configuration settings for the registry.protected abstract Counter newCounter(Id id)
id
- Identifier used to lookup this meter in the registry.protected abstract DistributionSummary newDistributionSummary(Id id)
id
- Identifier used to lookup this meter in the registry.protected abstract Timer newTimer(Id id)
id
- Identifier used to lookup this meter in the registry.protected abstract Gauge newGauge(Id id)
id
- Identifier used to lookup this meter in the registry.public final Clock clock()
Registry
public final RegistryConfig config()
Registry
public final Id createId(String name)
Registry
public final Id createId(String name, Iterable<Tag> tags)
Registry
public void register(Meter meter)
Registry
public final Counter counter(Id id)
Registry
counter
in interface Registry
id
- Identifier created by a call to Registry.createId(java.lang.String)
public final DistributionSummary distributionSummary(Id id)
Registry
distributionSummary
in interface Registry
id
- Identifier created by a call to Registry.createId(java.lang.String)
public final Timer timer(Id id)
Registry
timer
in interface Registry
id
- Identifier created by a call to Registry.createId(java.lang.String)
public final Gauge gauge(Id id)
Registry
Gauge.set(double)
.
Registry implementations are free to expire the gauge if it has not been updated in the
last minute. If you do not want to worry about the sampling, then use one of the helpers
linked below instead.gauge
in interface Registry
id
- Identifier created by a call to Registry.createId(java.lang.String)
Registry.gauge(Id, Number)
,
Registry.gauge(Id, Object, ToDoubleFunction)
,
Registry.collectionSize(Id, Collection)
,
Registry.mapSize(Id, Map)
public final Meter get(Id id)
Registry