com.tqdev.metrics.core

Class MetricRegistry

java.lang.Object

com.tqdev.metrics.core.MetricRegistry

public class MetricRegistry
extends Object

The Class MetricRegistry provides access to all metrics that are tracked.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled Metrics enabled status.
protected ConcurrentHashMap<String,ConcurrentHashMap<String,Object>>	values The values in the metric registry have a type and a key and are of type LongAdder or Gauge.

Constructor Summary

Constructors

Constructor and Description
MetricRegistry() Instantiates a new metric registry.
MetricRegistry(boolean enabled) Instantiates a new metric registry.

Method Summary

Modifier and Type	Method and Description
boolean	add(String type, String key, long value) Adds a value to a metric for a given type and key.
boolean	decrement(String type, String key) Decrement a metric for a given type and key.
long	get(String type, String key) Gets the value of a metric for a given type and key.
static MetricRegistry	getInstance() Gets the single instance of the Storage.
Iterable<String>	getKeys(String type) Gets the (unique) set of keys of all registered metrics of a given type.
long	getMillis() Gets the current (wall clock) time in milliseconds (milliseconds elapsed since epoch).
long	getNanos() Gets the elapsed time in nanoseconds (from an arbitrary point in time, probably JVM start).
Iterable<String>	getTypes() Gets the (unique) set of types of all registered metrics.
boolean	has(String type, String key) Checks for existence of a metric for a given type and key.
boolean	hasType(String type) Checks for existence of a metric for a given type.
boolean	increment(String type, String key) Increment a metric for a given type and key.
boolean	isEnabled() Checks if metrics are enabled.
void	reset() Resets the metric registry.
void	set(String type, String key, Gauge value) Sets the Gauge (measure function) of a metric for a given type and key.
void	set(String type, String key, long value) Sets the value of a metric for a given type and key.
void	setEnabled(boolean enabled) Sets the metrics enabled status.

Methods inherited from class java.lang.Object

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

Field Detail

values

protected volatile ConcurrentHashMap<String,ConcurrentHashMap<String,Object>> values

The values in the metric registry have a type and a key and are of type LongAdder or Gauge.

enabled

protected boolean enabled

Metrics enabled status.

Constructor Detail

MetricRegistry

public MetricRegistry()

Instantiates a new metric registry.

MetricRegistry

public MetricRegistry(boolean enabled)

Instantiates a new metric registry.

Method Detail

reset

public void reset()

Resets the metric registry.

isEnabled

public boolean isEnabled()

Checks if metrics are enabled.

Returns:

true, if metrics are enabled

setEnabled

public void setEnabled(boolean enabled)

Sets the metrics enabled status.

Parameters:

enabled - the new metrics enabled status

increment

public boolean increment(String type,
                         String key)

Increment a metric for a given type and key.

Parameters:

type - the type

key - the key

Returns:

true, if successful

decrement

public boolean decrement(String type,
                         String key)

Decrement a metric for a given type and key.

Parameters:

type - the type

key - the key

Returns:

true, if successful

add

public boolean add(String type,
                   String key,
                   long value)

Adds a value to a metric for a given type and key.

Parameters:

type - the type

key - the key

value - the value

Returns:

true, if successful

set

public void set(String type,
                String key,
                long value)

Sets the value of a metric for a given type and key.

Parameters:

type - the type

key - the key

value - the value

set

public void set(String type,
                String key,
                Gauge value)

Sets the Gauge (measure function) of a metric for a given type and key.

Parameters:

type - the type

key - the key

value - the value

getTypes

public Iterable<String> getTypes()

Gets the (unique) set of types of all registered metrics.

Returns:

the types

getKeys

public Iterable<String> getKeys(String type)

Gets the (unique) set of keys of all registered metrics of a given type.

Parameters:

type - the type

Returns:

the keys

has

public boolean has(String type,
                   String key)

Checks for existence of a metric for a given type and key.

Parameters:

type - the type

key - the key

Returns:

true, if successful

hasType

public boolean hasType(String type)

Checks for existence of a metric for a given type.

Parameters:

type - the type

Returns:

true, if successful

get

public long get(String type,
                String key)

Gets the value of a metric for a given type and key.

Parameters:

type - the type

key - the key

Returns:

the long

getNanos

public long getNanos()

Gets the elapsed time in nanoseconds (from an arbitrary point in time, probably JVM start).

Returns:

the time

getMillis

public long getMillis()

Gets the current (wall clock) time in milliseconds (milliseconds elapsed since epoch).

Returns:

the time

getInstance

public static MetricRegistry getInstance()

Gets the single instance of the Storage.

Returns:

single instance of Storage