Package org.apache.pinot.common.metrics

Enum BrokerGauge

java.lang.Object

java.lang.Enum<BrokerGauge>

org.apache.pinot.common.metrics.BrokerGauge

All Implemented Interfaces:

Serializable, Comparable<BrokerGauge>, java.lang.constant.Constable, AbstractMetrics.Gauge

public enum BrokerGauge
extends Enum<BrokerGauge>
implements AbstractMetrics.Gauge

Enumeration containing all the gauges 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
MAX_BURST_QPS
NETTY_CONNECTION_CONNECT_TIME_MS
QUERY_QUOTA_CAPACITY_UTILIZATION_RATE
QUERY_RATE_LIMIT_DISABLED
REQUEST_SIZE
RESIZE_TIME_MS
TIME_BOUNDARY_DIFFERENCE
UNHEALTHY_SERVERS
VERSION

Method Summary

Modifier and Type	Method	Description
String	getGaugeName()
String	getUnit()
boolean	isGlobal()	Returns true if the gauge is global (not attached to a particular resource)
static BrokerGauge	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BrokerGauge[]	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

VERSION

public static final BrokerGauge VERSION

QUERY_QUOTA_CAPACITY_UTILIZATION_RATE

public static final BrokerGauge QUERY_QUOTA_CAPACITY_UTILIZATION_RATE

MAX_BURST_QPS

public static final BrokerGauge MAX_BURST_QPS

QUERY_RATE_LIMIT_DISABLED

public static final BrokerGauge QUERY_RATE_LIMIT_DISABLED

NETTY_CONNECTION_CONNECT_TIME_MS

public static final BrokerGauge NETTY_CONNECTION_CONNECT_TIME_MS

REQUEST_SIZE

public static final BrokerGauge REQUEST_SIZE

RESIZE_TIME_MS

public static final BrokerGauge RESIZE_TIME_MS

UNHEALTHY_SERVERS

public static final BrokerGauge UNHEALTHY_SERVERS

TIME_BOUNDARY_DIFFERENCE

public static final BrokerGauge TIME_BOUNDARY_DIFFERENCE

Method Detail

values

public static BrokerGauge[] 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 BrokerGauge 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

getGaugeName

public String getGaugeName()

Specified by:

getGaugeName in interface AbstractMetrics.Gauge

getUnit

public String getUnit()

Specified by:

getUnit in interface AbstractMetrics.Gauge

isGlobal

public boolean isGlobal()

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

Specified by:

isGlobal in interface AbstractMetrics.Gauge

Returns:

true if the gauge is global