net.spy.memcached.metrics

Enum MetricType

java.lang.Object

java.lang.Enum<MetricType>

net.spy.memcached.metrics.MetricType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetricType>

public enum MetricType
extends java.lang.Enum<MetricType>

Defines the type of metric collection to use. More detailed types provide more insight, but can come with more overhead during collection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Metrics useful for debugging.
OFF No metrics collection.
PERFORMANCE Metrics useful for performance-related tracing.

Method Summary

Methods

Modifier and Type	Method and Description
static MetricType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MetricType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final MetricType OFF

No metrics collection. If the "OFF" type is chosen, no metrics will be registered and collected.

PERFORMANCE

public static final MetricType PERFORMANCE

Metrics useful for performance-related tracing. These metrics provide insight into the application performance and show how the operations flow in and out of the library.

DEBUG

public static final MetricType DEBUG

Metrics useful for debugging. These metrics (which include the PERFORMANCE metrics implicitly) provide more insight into the state of the library (for example node states), but it comes with larger aggregation overhead. Use during development and debug sessions.

Method Detail

values

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

Returns:

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

valueOf

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