Package com.linkedin.venice.stats.dimensions

Enum Class VeniceIngestionSourceComponent

java.lang.Object

java.lang.Enum<VeniceIngestionSourceComponent>

com.linkedin.venice.stats.dimensions.VeniceIngestionSourceComponent

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VeniceIngestionSourceComponent>, Constable

public enum VeniceIngestionSourceComponent
extends Enum<VeniceIngestionSourceComponent>
implements VeniceDimensionInterface

Dimension enum representing the source component in the ingestion flow. Used for metrics like ingestion latency between components.

Note: Similar to VeniceIngestionDestinationComponent. These are 2 different enums with same values to provide type safety when defining and recording metrics.

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
FOLLOWER_CONSUMER	The follower replica consumer that replicates from leader
LEADER_CONSUMER	The leader replica consumer that processes messages first
LOCAL_BROKER	The local Kafka broker in the same region
PRODUCER	The original producer that created the message
SOURCE_BROKER	The source Kafka broker from a remote region

Method Summary

Modifier and Type	Method	Description
VeniceMetricsDimensions	getDimensionName()	Dimension name: Returns the VeniceMetricsDimensions for the enum.
String	getDimensionValue()	Dimension value: Returns the dimension value for each enum instance.
static VeniceIngestionSourceComponent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeniceIngestionSourceComponent[]	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

Enum Constant Details

PRODUCER

public static final VeniceIngestionSourceComponent PRODUCER

The original producer that created the message

LOCAL_BROKER

public static final VeniceIngestionSourceComponent LOCAL_BROKER

The local Kafka broker in the same region

SOURCE_BROKER

public static final VeniceIngestionSourceComponent SOURCE_BROKER

The source Kafka broker from a remote region

LEADER_CONSUMER

public static final VeniceIngestionSourceComponent LEADER_CONSUMER

The leader replica consumer that processes messages first

FOLLOWER_CONSUMER

public static final VeniceIngestionSourceComponent FOLLOWER_CONSUMER

The follower replica consumer that replicates from leader

Method Details

values

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

getDimensionValue

public String getDimensionValue()

Description copied from interface: VeniceDimensionInterface

Dimension value: Returns the dimension value for each enum instance.

Specified by:

getDimensionValue in interface VeniceDimensionInterface