com.twitter.heron.api.metric

Enum GlobalMetrics

java.lang.Object

java.lang.Enum<GlobalMetrics>

com.twitter.heron.api.metric.GlobalMetrics

All Implemented Interfaces:

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

public enum GlobalMetrics
extends java.lang.Enum<GlobalMetrics>
implements java.io.Serializable

Singleton class which exposes a simple globally available counter for heron jobs. Anywhere in the execution of heron job, user can put- GlobalMetrics.incr("mycounter") to add a counter. There will be no need to explicitly declare the counter before. If the counter doesn't exist it will be created. The creation is lazy which means, unless the counter not being available, it is counted as 0 CounterFactory.init() should be called in prepare and open methods of bolt and spout respectively. The counters will be named __auto__/mycounter (note the __auto__ prefix)

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT_NAME

Method Summary

Methods

Modifier and Type	Method and Description
static MultiCountMetric	getUnderlyingCounter() test-only
static void	incr(java.lang.String counterName) Not thread safe increment of counterName.
static void	incrBy(java.lang.String counterName, int N) Not thread safe 'incrementing by' of counterName.
static void	init(IMetricsRegister metricsRegister, int metricsBucket) Initialize the counter by registering the metricContainer.
protected java.lang.Object	readResolve() During serialization don't create a copy of this class.
static void	safeIncr(java.lang.String counterName) Thread safe created increment of counterName.
static void	safeIncrBy(java.lang.String counterName, int N) Thread safe created increment of counterName.
static GlobalMetrics	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GlobalMetrics[]	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 GlobalMetrics INSTANCE

Field Detail

ROOT_NAME

public static java.lang.String ROOT_NAME

Method Detail

values

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

Returns:

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

valueOf

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

incr

public static void incr(java.lang.String counterName)

Not thread safe increment of counterName. Counter doesn't exist unless incremented once

incrBy

public static void incrBy(java.lang.String counterName,
          int N)

Not thread safe 'incrementing by' of counterName. Counter doesn't exist unless incremented once

safeIncr

public static void safeIncr(java.lang.String counterName)

Thread safe created increment of counterName. (Slow)

readResolve

protected java.lang.Object readResolve()

During serialization don't create a copy of this class. 'readResolve' is used by reflection for java serialization.

safeIncrBy

public static void safeIncrBy(java.lang.String counterName,
              int N)

Thread safe created increment of counterName. (Slow)

init

public static void init(IMetricsRegister metricsRegister,
        int metricsBucket)

Initialize the counter by registering the metricContainer. Should be done in open/prepare call. TODO: Investigate if it is possible to do this part in ctor. One thing to note is how this will affect the serialization of CounterFactory.

getUnderlyingCounter

public static MultiCountMetric getUnderlyingCounter()

test-only