Package com.hcl.labs.domi.metrics

Enum DOMIStatisticsHolder

java.lang.Object

java.lang.Enum<DOMIStatisticsHolder>

com.hcl.labs.domi.metrics.DOMIStatisticsHolder

All Implemented Interfaces:

DOMIStatistics, Serializable, Comparable<DOMIStatisticsHolder>

public enum DOMIStatisticsHolder
extends Enum<DOMIStatisticsHolder>
implements DOMIStatistics

Holder for Keep statistics

Author:

Paul Stephen Withers

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.labs.domi.metrics.DOMIStatistics

DOMIStatistics.StatisticAction

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Singleton holder for statistic data

Method Summary

Modifier and Type	Method	Description
io.micrometer.core.instrument.Meter	createMetricForRegistry(String key, List<io.micrometer.core.instrument.Tag> metricsTags, io.micrometer.core.instrument.Meter.Type type, io.micrometer.core.instrument.MeterRegistry registry)	Creates a counter or timer for a specific registry, currently only Prometheus.
Map<String,io.micrometer.core.instrument.Meter>	getMetricsMap()
io.micrometer.core.instrument.Counter	getOrCreateCounter(String key, List<io.micrometer.core.instrument.Tag> metricsTags)	Gets or creates a counter.
io.micrometer.core.instrument.Timer	getOrCreateTimer(String key, List<io.micrometer.core.instrument.Tag> metricsTags)	Gets or creates a counter.
void	incrementCounter(String key, List<io.micrometer.core.instrument.Tag> metricsTags)
DOMIStatistics	reset()	Resets the statistics to start over.
static DOMIStatisticsHolder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DOMIStatisticsHolder[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final DOMIStatisticsHolder INSTANCE

Singleton holder for statistic data

Method Detail

values

public static DOMIStatisticsHolder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DOMIStatisticsHolder c : DOMIStatisticsHolder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DOMIStatisticsHolder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createMetricForRegistry

public io.micrometer.core.instrument.Meter createMetricForRegistry(String key,
                                                                   List<io.micrometer.core.instrument.Tag> metricsTags,
                                                                   io.micrometer.core.instrument.Meter.Type type,
                                                                   io.micrometer.core.instrument.MeterRegistry registry)

Description copied from interface: DOMIStatistics

Creates a counter or timer for a specific registry, currently only Prometheus.

Specified by:

createMetricForRegistry in interface DOMIStatistics

Parameters:

key - to create metric with

metricsTags - to create metric with

type - of Meter to create. Only Timer and Counter are currently supported

registry - registry into which to create the metric

Returns:

Meter created

getMetricsMap

public Map<String,io.micrometer.core.instrument.Meter> getMetricsMap()

Specified by:

getMetricsMap in interface DOMIStatistics

Returns:

Map of metrics

getOrCreateCounter

public io.micrometer.core.instrument.Counter getOrCreateCounter(String key,
                                                                List<io.micrometer.core.instrument.Tag> metricsTags)

Description copied from interface: DOMIStatistics

Gets or creates a counter. Use this if tags require minimal computation to pass

Specified by:

getOrCreateCounter in interface DOMIStatistics

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Counter) created

getOrCreateTimer

public io.micrometer.core.instrument.Timer getOrCreateTimer(String key,
                                                            List<io.micrometer.core.instrument.Tag> metricsTags)

Description copied from interface: DOMIStatistics

Gets or creates a counter. Use this if tags require minimal computation to pass

Specified by:

getOrCreateTimer in interface DOMIStatistics

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Timer) created

incrementCounter

public void incrementCounter(String key,
                             List<io.micrometer.core.instrument.Tag> metricsTags)

Parameters:

key - for the metric

metricsTags - list of tags

reset

public DOMIStatistics reset()

Description copied from interface: DOMIStatistics

Resets the statistics to start over. Mainly used when restarting keep

Specified by:

reset in interface DOMIStatistics

Returns:

fluent