Package com.linkedin.venice.stats.dimensions

Enum Class VeniceHeartbeatComponent

java.lang.Object

java.lang.Enum<VeniceHeartbeatComponent>

com.linkedin.venice.stats.dimensions.VeniceHeartbeatComponent

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VeniceHeartbeatComponent>, Constable

public enum VeniceHeartbeatComponent
extends Enum<VeniceHeartbeatComponent>
implements VeniceDimensionInterface

Dimension enum representing the heartbeat monitoring service thread components. Each value corresponds to a distinct background thread within the heartbeat monitoring service. Maps to VeniceMetricsDimensions.VENICE_HEARTBEAT_COMPONENT.

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
LOGGER	The heartbeat logger thread that logs lag delays and cleans up stale monitors.
REPORTER	The heartbeat reporter thread that publishes lag metrics.

Method Summary

Modifier and Type	Method	Description
VeniceMetricsDimensions	getDimensionName()	Dimension name: Returns the VeniceMetricsDimensions for the enum.
static VeniceHeartbeatComponent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeniceHeartbeatComponent[]	values()	Returns an array containing the constants of this enum class, 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

Methods inherited from interface com.linkedin.venice.stats.dimensions.VeniceDimensionInterface

getDimensionValue

Enum Constant Details

REPORTER

public static final VeniceHeartbeatComponent REPORTER

The heartbeat reporter thread that publishes lag metrics.

LOGGER

public static final VeniceHeartbeatComponent LOGGER

The heartbeat logger thread that logs lag delays and cleans up stale monitors.

Method Details

values

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

getDimensionName

public VeniceMetricsDimensions getDimensionName()

Description copied from interface: VeniceDimensionInterface

Dimension name: Returns the VeniceMetricsDimensions for the enum. All the instances of a Enum class should have the same dimension name. Ideally this could have been a static variable/method in the Enum class, but to enforce having this method via this interface, it is made as a non-static method.

Specified by:

getDimensionName in interface VeniceDimensionInterface