Package org.apache.pinot.common.metrics

Enum BrokerTimer

java.lang.Object

java.lang.Enum<BrokerTimer>

org.apache.pinot.common.metrics.BrokerTimer

All Implemented Interfaces:

Serializable, Comparable<BrokerTimer>, java.lang.constant.Constable, AbstractMetrics.Timer

public enum BrokerTimer
extends Enum<BrokerTimer>
implements AbstractMetrics.Timer

Enumeration containing all the timers exposed by the Pinot broker.

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
CLUSTER_CHANGE_QUEUE_TIME
FRESHNESS_LAG_MS
NETTY_CONNECTION_SEND_REQUEST_LATENCY
OFFLINE_RESPONSE_SER_CPU_TIME_NS
OFFLINE_SYSTEM_ACTIVITIES_CPU_TIME_NS
OFFLINE_THREAD_CPU_TIME_NS
OFFLINE_TOTAL_CPU_TIME_NS
QUERY_TOTAL_TIME_MS
REALTIME_RESPONSE_SER_CPU_TIME_NS
REALTIME_SYSTEM_ACTIVITIES_CPU_TIME_NS
REALTIME_THREAD_CPU_TIME_NS
REALTIME_TOTAL_CPU_TIME_NS
ROUTING_TABLE_UPDATE_TIME

Method Summary

Modifier and Type	Method	Description
String	getTimerName()
boolean	isGlobal()	Returns true if the timer is global (not attached to a particular resource)
static BrokerTimer	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BrokerTimer[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROUTING_TABLE_UPDATE_TIME

public static final BrokerTimer ROUTING_TABLE_UPDATE_TIME

CLUSTER_CHANGE_QUEUE_TIME

public static final BrokerTimer CLUSTER_CHANGE_QUEUE_TIME

FRESHNESS_LAG_MS

public static final BrokerTimer FRESHNESS_LAG_MS

QUERY_TOTAL_TIME_MS

public static final BrokerTimer QUERY_TOTAL_TIME_MS

NETTY_CONNECTION_SEND_REQUEST_LATENCY

public static final BrokerTimer NETTY_CONNECTION_SEND_REQUEST_LATENCY

OFFLINE_THREAD_CPU_TIME_NS

public static final BrokerTimer OFFLINE_THREAD_CPU_TIME_NS

REALTIME_THREAD_CPU_TIME_NS

public static final BrokerTimer REALTIME_THREAD_CPU_TIME_NS

OFFLINE_SYSTEM_ACTIVITIES_CPU_TIME_NS

public static final BrokerTimer OFFLINE_SYSTEM_ACTIVITIES_CPU_TIME_NS

REALTIME_SYSTEM_ACTIVITIES_CPU_TIME_NS

public static final BrokerTimer REALTIME_SYSTEM_ACTIVITIES_CPU_TIME_NS

OFFLINE_RESPONSE_SER_CPU_TIME_NS

public static final BrokerTimer OFFLINE_RESPONSE_SER_CPU_TIME_NS

REALTIME_RESPONSE_SER_CPU_TIME_NS

public static final BrokerTimer REALTIME_RESPONSE_SER_CPU_TIME_NS

OFFLINE_TOTAL_CPU_TIME_NS

public static final BrokerTimer OFFLINE_TOTAL_CPU_TIME_NS

REALTIME_TOTAL_CPU_TIME_NS

public static final BrokerTimer REALTIME_TOTAL_CPU_TIME_NS

Method Detail

values

public static BrokerTimer[] values()

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

Returns:

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

valueOf

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

getTimerName

public String getTimerName()

Specified by:

getTimerName in interface AbstractMetrics.Timer

isGlobal

public boolean isGlobal()

Returns true if the timer is global (not attached to a particular resource)

Specified by:

isGlobal in interface AbstractMetrics.Timer

Returns:

true if the timer is global