Package com.linkedin.venice.stats.dimensions

Enum Class VenicePushJobStatus

java.lang.Object
java.lang.Enum<VenicePushJobStatus>
com.linkedin.venice.stats.dimensions.VenicePushJobStatus
All Implemented Interfaces:
VeniceDimensionInterface, Serializable, Comparable<VenicePushJobStatus>, Constable
public enum VenicePushJobStatus extends Enum<VenicePushJobStatus> implements VeniceDimensionInterface
Dimension enum representing the terminal status of a Venice push job. Used to categorize push job completions into success, user-caused failures, and system-caused failures within a single consolidated OTel counter metric.

The classification of failures into user vs system error is determined by the push job's latest checkpoint. Checkpoints listed in DEFAULT_PUSH_JOB_USER_ERROR_CHECKPOINTS (e.g., quota exceeded, write ACL failure, duplicate keys, schema validation failures, record too large, concurrent batch push, disk full, memory limit) are classified as USER_ERROR. All other failure checkpoints are classified as SYSTEM_ERROR. Maps to VeniceMetricsDimensions.VENICE_PUSH_JOB_STATUS.

  • Enum Constant Details

    • SUCCESS

      public static final VenicePushJobStatus SUCCESS
      The push job completed successfully and data is available for serving.

    • USER_ERROR

      public static final VenicePushJobStatus USER_ERROR
      The push job failed due to a user-caused error, such as quota exceeded, write ACL failure, duplicate keys with different values, schema validation failure, record too large, concurrent batch push, dataset changed, invalid input file, DaVinci disk full, or DaVinci memory limit.

    • SYSTEM_ERROR

      public static final VenicePushJobStatus SYSTEM_ERROR
      The push job failed due to a system-caused error, such as infrastructure failures, internal service errors, or any failure checkpoint not classified as a user error.

  • Method Details

    • values

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