Package com.linkedin.venice.stats.dimensions

Enum Class VenicePushJobDurationBucket

java.lang.Object

java.lang.Enum<VenicePushJobDurationBucket>

com.linkedin.venice.stats.dimensions.VenicePushJobDurationBucket

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VenicePushJobDurationBucket>, Constable

public enum VenicePushJobDurationBucket
extends Enum<VenicePushJobDurationBucket>
implements VeniceDimensionInterface

Push duration relative to the SLA threshold configured by ConfigKeys.CONTROLLER_PUSH_JOB_SLA_MS, independent of the push's execution state. Used only for terminal push-job statuses, for which the job duration is nonnegative.

Use alongside VeniceMetricsDimensions.VENICE_PUSH_JOB_EXECUTION_STATE when evaluating completion SLAs. For example, a user-cancelled push with execution state killed and bucket UNDER_SLA was stopped before Venice's configured completion window elapsed. Such an early user cancellation should not be attributed to Venice failing to meet its completion SLA.

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
AT_OR_OVER_SLA	A push duration at or above the configured SLA threshold.
UNDER_SLA	A push duration strictly below the configured SLA threshold.

Method Summary

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

UNDER_SLA

public static final VenicePushJobDurationBucket UNDER_SLA

A push duration strictly below the configured SLA threshold.

AT_OR_OVER_SLA

public static final VenicePushJobDurationBucket AT_OR_OVER_SLA

A push duration at or above the configured SLA threshold.

Method Details

values

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