Module com.erudika.para.server

Package com.erudika.para.server.metrics

Enum Class MetricsUtils

java.lang.Object

java.lang.Enum<MetricsUtils>

com.erudika.para.server.metrics.MetricsUtils

All Implemented Interfaces:

com.erudika.para.core.listeners.InitializeListener, Serializable, Comparable<MetricsUtils>, Constable, Runnable, EventListener

public enum MetricsUtils
extends Enum<MetricsUtils>
implements com.erudika.para.core.listeners.InitializeListener, Runnable

A centralized utility for managing and retrieving all Para performance metrics.

Author:

Jeremy Wiesner [[email protected]]

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Singleton.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GRAPHITE_APP_SETTINGS_NAME	The name of the app settings object that contains the info to push an app's metrics to Graphite.
static final String	GRAPHITE_REGISTRY_NAME	The name of the registry holding app-specific settings for reporting metrics to Graphite.

Method Summary

Modifier and Type	Method	Description
static MetricsUtils	getInstance()	Provides access to the singleton instance methods.
static void	removeAppSetting(com.erudika.para.core.App app, String key)	A listener method to process removed settings for an application (including the root app).
static MetricsUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricsUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.erudika.para.core.listeners.InitializeListener

onInitialize

Methods inherited from interface java.lang.Runnable

run

Enum Constant Details

INSTANCE

public static final MetricsUtils INSTANCE

Singleton.

Field Details

GRAPHITE_REGISTRY_NAME

public static final String GRAPHITE_REGISTRY_NAME

The name of the registry holding app-specific settings for reporting metrics to Graphite.

See Also:

• Constant Field Values

GRAPHITE_APP_SETTINGS_NAME

public static final String GRAPHITE_APP_SETTINGS_NAME

The name of the app settings object that contains the info to push an app's metrics to Graphite.

See Also:

• Constant Field Values

Method Details

values

public static MetricsUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MetricsUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getInstance

public static MetricsUtils getInstance()

Provides access to the singleton instance methods.

Returns:

an instance of this class

removeAppSetting

public static void removeAppSetting(com.erudika.para.core.App app,
 String key)

A listener method to process removed settings for an application (including the root app).

Parameters:

app - the application the setting was removed from.

key - the name of the setting