com.hcl.domino.keep.metrics

Enum KeepStatisticsHolder

java.lang.Object

java.lang.Enum<KeepStatisticsHolder>

com.hcl.domino.keep.metrics.KeepStatisticsHolder

All Implemented Interfaces:

KeepStatistics, java.io.Serializable, java.lang.Comparable<KeepStatisticsHolder>

public enum KeepStatisticsHolder
extends java.lang.Enum<KeepStatisticsHolder>
implements KeepStatistics

Holder for Keep statistics

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.metrics.KeepStatistics

KeepStatistics.StatisticAction, KeepStatistics.TagKey

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton holder for statistic data

Method Summary

Modifier and Type	Method and Description
KeepStatistics	adjustConfiguredForms(KeepDbInfo dbInfo, KeepStatistics.StatisticAction action) Adjusts number of configured forms
KeepStatistics	adjustConfiguredForms(KeepStatistics.StatisticAction action) Adjusts number of configured forms by 1, up or down
io.micrometer.core.instrument.Meter	createMetricForRegistry(java.lang.String key, java.util.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.
java.util.Map<java.lang.String,io.micrometer.core.instrument.Meter>	getMetricsMap()
io.micrometer.core.instrument.Counter	getOrCreateCounter(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags) Gets or creates a counter.
io.micrometer.core.instrument.Timer	getOrCreateTimer(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags) Gets or creates a counter.
void	incrementCounter(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags)
KeepStatistics	reset() Resets the statistics to start over.
static KeepStatisticsHolder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeepStatisticsHolder[]	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 KeepStatisticsHolder INSTANCE

Singleton holder for statistic data

Method Detail

values

public static KeepStatisticsHolder[] 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 (KeepStatisticsHolder c : KeepStatisticsHolder.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeepStatisticsHolder valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

adjustConfiguredForms

public KeepStatistics adjustConfiguredForms(KeepDbInfo dbInfo,
                                            KeepStatistics.StatisticAction action)

Description copied from interface: KeepStatistics

Adjusts number of configured forms

Specified by:

adjustConfiguredForms in interface KeepStatistics

Parameters:

dbInfo - KeepDbInfo to process

action - increment or decrement

Returns:

fluent

adjustConfiguredForms

public KeepStatistics adjustConfiguredForms(KeepStatistics.StatisticAction action)

Description copied from interface: KeepStatistics

Adjusts number of configured forms by 1, up or down

Specified by:

adjustConfiguredForms in interface KeepStatistics

Parameters:

action - increment or decrement

Returns:

fluent

createMetricForRegistry

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

Description copied from interface: KeepStatistics

Creates a counter or timer for a specific registry. Currently the only registry in use is Prometheus. The future approach will call this recursively for all registries enabled

Specified by:

createMetricForRegistry in interface KeepStatistics

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 java.util.Map<java.lang.String,io.micrometer.core.instrument.Meter> getMetricsMap()

Specified by:

getMetricsMap in interface KeepStatistics

Returns:

Map of metrics

getOrCreateCounter

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

Description copied from interface: KeepStatistics

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

Specified by:

getOrCreateCounter in interface KeepStatistics

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Counter) created

getOrCreateTimer

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

Description copied from interface: KeepStatistics

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

Specified by:

getOrCreateTimer in interface KeepStatistics

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Timer) created

incrementCounter

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

Parameters:

key -

metricsTags -

reset

public KeepStatistics reset()

Description copied from interface: KeepStatistics

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

Specified by:

reset in interface KeepStatistics

Returns:

fluent