com.netflix.spectator.api

Class NoopRegistry

java.lang.Object

com.netflix.spectator.api.NoopRegistry

All Implemented Interfaces:

Registry, Iterable<Meter>

public final class NoopRegistry
extends Object
implements Registry

Registry implementation that does nothing. This is typically used to allow for performance tests to see how much overhead is being added by instrumentation. This implementation tries to do the minimum amount possible without requiring code changes for users.

Constructor Summary

Constructors

Constructor and Description
NoopRegistry()

Method Summary

Modifier and Type	Method and Description
Clock	clock() The clock used by the registry for timing events.
Counter	counter(DynamicId id) Measures the rate of some activity.
Counter	counter(Id id) Measures the rate of some activity.
DynamicId	createDynamicId(String name) Creates a dynamic identifier for a meter.
DynamicId	createDynamicId(String name, Iterable<TagFactory> tagFactories) Creates a dynamic identifier for a meter.
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(DynamicId id) Measures the rate and variation in amount for some activity.
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.
void	register(Meter meter) Add a custom meter to the registry.
Timer	timer(DynamicId id) Measures the rate and time taken for short running tasks.
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, longTaskTimer, longTaskTimer, longTaskTimer, longTaskTimer, mapSize, mapSize, methodValue, methodValue, stream, timer, timer, timer, timers, underlying

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NoopRegistry

public NoopRegistry()

Method Detail

clock

public Clock clock()

Description copied from interface: Registry

The clock used by the registry for timing events.

Specified by:

clock in interface Registry

createId

public 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 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.

createDynamicId

public DynamicId createDynamicId(String name)

Description copied from interface: Registry

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

Specified by:

createDynamicId in interface Registry

Parameters:

name - Description of the measurement that is being collected.

Returns:

The newly created dynamic identifier.

createDynamicId

public DynamicId createDynamicId(String name,
                                 Iterable<TagFactory> tagFactories)

Description copied from interface: Registry

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

Specified by:

createDynamicId in interface Registry

Parameters:

name - Description of the measurement that is being collected.

tagFactories - Other factories that can generate other dimensions that can be used to classify the measurement.

Returns:

The newly created dynamic identifier.

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

counter

public Counter counter(DynamicId 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.createDynamicId(java.lang.String)

distributionSummary

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

distributionSummary

public DistributionSummary distributionSummary(DynamicId 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.createDynamicId(java.lang.String)

timer

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

timer

public Timer timer(DynamicId 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.createDynamicId(java.lang.String)

get

public 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 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>