Package com.linkedin.venice.stats.dimensions

Enum Class VeniceResponseStatusCategory

java.lang.Object

java.lang.Enum<VeniceResponseStatusCategory>

com.linkedin.venice.stats.dimensions.VeniceResponseStatusCategory

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VeniceResponseStatusCategory>, Constable

public enum VeniceResponseStatusCategory
extends Enum<VeniceResponseStatusCategory>
implements VeniceDimensionInterface

How Venice categorizes the response status of a request: well as the Venice specific categorization. For instance, venice considers key not found as a healthy response, but http standard would consider it a 404 (4xx) which leads to checking for both 200 and 404 to account for all healthy requests. This dimensions makes it easier to make Venice specific aggregations.

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
FAIL
SUCCESS

Method Summary

Modifier and Type	Method	Description
VeniceMetricsDimensions	getDimensionName()	All the instances of this Enum should have the same dimension name.
static VeniceResponseStatusCategory	getVeniceResponseStatusCategory(io.netty.handler.codec.http.HttpResponseStatus responseStatus)	Maps an HTTP response status to the Venice-specific category.
static VeniceResponseStatusCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeniceResponseStatusCategory[]	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

SUCCESS

public static final VeniceResponseStatusCategory SUCCESS

FAIL

public static final VeniceResponseStatusCategory FAIL

Method Details

values

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

getVeniceResponseStatusCategory

public static VeniceResponseStatusCategory getVeniceResponseStatusCategory(io.netty.handler.codec.http.HttpResponseStatus responseStatus)

Maps an HTTP response status to the Venice-specific category. In Venice, HttpResponseStatus.NOT_FOUND (key absent) is a valid/expected outcome, so both HttpResponseStatus.OK and HttpResponseStatus.NOT_FOUND are classified as SUCCESS; everything else is FAIL.

getDimensionName

public VeniceMetricsDimensions getDimensionName()

All the instances of this Enum should have the same dimension name. Refer VeniceDimensionInterface.getDimensionName() for more details.

Specified by:

getDimensionName in interface VeniceDimensionInterface