com.netflix.spectator.api

Class AbstractRegistry

java.lang.Object

com.netflix.spectator.api.AbstractRegistry

All Implemented Interfaces:

Registry, Iterable<Meter>

Direct Known Subclasses:

DefaultRegistry

public abstract class AbstractRegistry
extends Object
implements Registry

Base class to make it easier to implement a simple registry that only needs to customise the types returned for Counter, DistributionSummary, and Timer calls.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger instance for the class.

Constructor Summary

Constructors

Constructor and Description
AbstractRegistry(Clock clock) Create a new instance.
AbstractRegistry(Clock clock, RegistryConfig config) Create a new instance.

Method Summary

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.
protected <T extends Meter> T	getOrCreate(Id id, Class<T> cls, T dflt, Function<Id,T> factory) Helper used to get or create an instance of a core meter type.
Iterator<Meter>	iterator() Iterator for traversing the set of meters in the registry.
Gauge	maxGauge(Id id) Measures the maximum value recorded since the last reset.
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 Gauge	newMaxGauge(Id id) Create a new max 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) Register a passive gauge.
protected void	removeExpiredMeters() Can be called by sub-classes to remove expired meters from the internal map.
protected void	reset() This can be called be sub-classes to reset all state for the registry.
ConcurrentMap<Id,Object>	state() Returns a map that can be used to associate state with the registry.
Timer	timer(Id id) Measures the rate and time taken for short running tasks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.netflix.spectator.api.Registry

collectionSize, collectionSize, counter, counter, counter, counters, createId, createId, distributionSummaries, distributionSummary, distributionSummary, distributionSummary, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauges, longTaskTimer, longTaskTimer, longTaskTimer, longTaskTimer, mapSize, mapSize, maxGauge, maxGauge, maxGauge, measurements, methodValue, methodValue, propagate, propagate, stream, timer, timer, timer, timers, underlying

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

logger

protected final org.slf4j.Logger logger

Logger instance for the class.

Constructor Detail

AbstractRegistry

public AbstractRegistry(Clock clock)

Create a new instance.

Parameters:

clock - Clock used for performing all timing measurements.

AbstractRegistry

public AbstractRegistry(Clock clock,
                        RegistryConfig config)

Create a new instance.

Parameters:

clock - Clock used for performing all timing measurements.

config - Configuration settings for the registry.

Method Detail

newCounter

protected abstract Counter newCounter(Id id)

Create a new counter instance for a given id.

Parameters:

id - Identifier used to lookup this meter in the registry.

Returns:

New counter instance.

newDistributionSummary

protected abstract DistributionSummary newDistributionSummary(Id id)

Create a new distribution summary instance for a given id.

Parameters:

id - Identifier used to lookup this meter in the registry.

Returns:

New distribution summary instance.

newTimer

protected abstract Timer newTimer(Id id)

Create a new timer instance for a given id.

Parameters:

id - Identifier used to lookup this meter in the registry.

Returns:

New timer instance.

newGauge

protected abstract Gauge newGauge(Id id)

Create a new gauge instance for a given id.

Parameters:

id - Identifier used to lookup this meter in the registry.

Returns:

New gauge instance.

newMaxGauge

protected abstract Gauge newMaxGauge(Id id)

Create a new max gauge instance for a given id.

Parameters:

id - Identifier used to lookup this meter in the registry.

Returns:

New gauge instance.

clock

public final Clock clock()

Description copied from interface: Registry

The clock used by the registry for timing events.

Specified by:

clock in interface Registry

config

public final RegistryConfig config()

Description copied from interface: Registry

Configuration settings used for this registry.

Specified by:

config in interface Registry

createId

public final Id createId(String name)

Description copied from interface: Registry

Creates an identifier for a meter. All ids passed into other calls should be created by the registry.

Specified by:

createId in interface Registry

Parameters:

name - Description of the measurement that is being collected.

createId

public final Id createId(String name,
                         Iterable<Tag> tags)

Description copied from interface: Registry

Creates an identifier for a meter. All ids passed into other calls should be created by the registry.

Specified by:

createId in interface Registry

Parameters:

name - Description of the measurement that is being collected.

tags - Other dimensions that can be used to classify the measurement.

register

public void register(Meter meter)

Description copied from interface: Registry

Register a passive gauge. In most cases users should not use this method directly. Use one of the helper methods for working with gauges.

Specified by:

register in interface Registry

See Also:

Registry.gauge(Id, Number), Registry.gauge(Id, Object, ToDoubleFunction), Registry.collectionSize(Id, Collection), Registry.mapSize(Id, Map)

state

public ConcurrentMap<Id,Object> state()

Description copied from interface: Registry

Returns a map that can be used to associate state with the registry. Users instrumenting their application will most likely never need to use this method. The primary use case is for building custom meter types that need some additional state beyond the core types supported by the registry. This map can be used to store the state so that the lifecycle of the data is connected to the registry. For an example, see some of the built in patterns such as LongTaskTimer.

Specified by:

state in interface Registry

counter

public final Counter counter(Id id)

Description copied from interface: Registry

Measures the rate of some activity. A counter is for continuously incrementing sources like the number of requests that are coming into a server.

Specified by:

counter in interface Registry

Parameters:

id - Identifier created by a call to Registry.createId(java.lang.String)

distributionSummary

public final DistributionSummary distributionSummary(Id id)

Description copied from interface: Registry

Measures the rate and variation in amount for some activity. For example, it could be used to get insight into the variation in response sizes for requests to a server.

Specified by:

distributionSummary in interface Registry

Parameters:

id - Identifier created by a call to Registry.createId(java.lang.String)

timer

public final Timer timer(Id id)

Description copied from interface: Registry

Measures the rate and time taken for short running tasks.

Specified by:

timer in interface Registry

Parameters:

id - Identifier created by a call to Registry.createId(java.lang.String)

gauge

public final Gauge gauge(Id id)

Description copied from interface: Registry

Represents a value sampled from another source. For example, the size of queue. The caller is responsible for sampling the value regularly and calling 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 PolledMeter instead.

Specified by:

gauge in interface Registry

Parameters:

id - Identifier created by a call to Registry.createId(java.lang.String)

maxGauge

public final Gauge maxGauge(Id id)

Description copied from interface: Registry

Measures the maximum value recorded since the last reset. For example, to measure the maximum number of concurrent requests to a service. In many cases it is better to use a Registry.distributionSummary(Id) which provides a max along with other stats for most registry implementations.

Specified by:

maxGauge in interface Registry

Parameters:

id - Identifier created by a call to Registry.createId(java.lang.String)

getOrCreate

protected <T extends Meter> T getOrCreate(Id id,
                                          Class<T> cls,
                                          T dflt,
                                          Function<Id,T> factory)

Helper used to get or create an instance of a core meter type. This is mostly used internally to this implementation, but may be useful in rare cases for creating customizations based on a core type in a sub-class.

Parameters:

id - Identifier used to lookup this meter in the registry.

cls - Type of the meter.

dflt - Default value used if there is a failure during the lookup and it is not configured to propagate.

factory - Function for creating a new instance of the meter type if one is not already available in the registry.

Returns:

Instance of the meter.

get

public final Meter get(Id id)

Description copied from interface: Registry

Returns the meter associated with a given id.

Specified by:

get in interface Registry

Parameters:

id - Identifier for the meter.

Returns:

Instance of the meter or null if there is no match.

iterator

public final Iterator<Meter> iterator()

Description copied from interface: Registry

Iterator for traversing the set of meters in the registry.

Specified by:

iterator in interface Registry

Specified by:

iterator in interface Iterable<Meter>

removeExpiredMeters

protected void removeExpiredMeters()

Can be called by sub-classes to remove expired meters from the internal map. The SwapMeter types that are returned will lookup a new copy on the next access.

reset

protected void reset()

This can be called be sub-classes to reset all state for the registry. Typically this should only be exposed for test registries as most users should not be able to reset the state and interrupt metrics collection for the overall system.