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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Clock	clock() The clock used by the registry for timing events.
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.
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 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.

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, counter, counters, createDynamicId, createDynamicId, createId, createId, distributionSummaries, distributionSummary, distributionSummary, distributionSummary, distributionSummary, gauge, gauge, gauge, gauge, gauge, gauge, gauge, longTaskTimer, longTaskTimer, longTaskTimer, longTaskTimer, mapSize, mapSize, methodValue, methodValue, stream, timer, timer, timer, timer, timers, underlying

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractRegistry

public AbstractRegistry(Clock clock)

Create a new instance.

Parameters:

clock - Clock used for performing all timing measurements.

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.

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

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

Add a custom meter to the registry.

Specified by:

register 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)

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>