Package com.linkedin.venice.client.stats

Enum Class ClientMetricEntity

java.lang.Object

java.lang.Enum<ClientMetricEntity>

com.linkedin.venice.client.stats.ClientMetricEntity

All Implemented Interfaces:

ModuleMetricEntityInterface, Serializable, Comparable<ClientMetricEntity>, Constable

public enum ClientMetricEntity
extends Enum<ClientMetricEntity>
implements ModuleMetricEntityInterface

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
CALL_SUBMISSION_TO_HANDLING_TIME	Time between client submitting a request and beginning to handle the response.
REQUEST_DUPLICATE_KEY_COUNT	Client duplicate key count.
REQUEST_SERIALIZATION_TIME	Request serialization time in milliseconds.
REQUEST_TIMEOUT_COUNT	Count of requests that timed out on the client side based on the future.get(timeout).
REQUEST_TIMEOUT_PARTIAL_RESPONSE_RATIO	Ratio of keys that were successfully retrieved to the total number of keys requested before timeout.
REQUEST_TIMEOUT_REQUESTED_DURATION	The timeout duration (in milliseconds) that was configured for client Future.
RESPONSE_BATCH_STREAM_PROGRESS_TIME	Batch streaming progress time in milliseconds: Elapsed time from when the client starts receiving the response to when the first/P50th/P90th record arrives and is processed.
RESPONSE_DECOMPRESSION_TIME	Response decompression time in milliseconds.
RESPONSE_DESERIALIZATION_TIME	Response deserialization time in milliseconds.
RETRY_CALL_COUNT	Client retry count.
RETRY_REQUEST_KEY_COUNT	Client retry key count.
RETRY_RESPONSE_KEY_COUNT	Client retry response key count.
ROUTE_CALL_COUNT	Count of all requests routed to different hosts.
ROUTE_CALL_TIME	Time taken for requests routed to different hosts.
ROUTE_REQUEST_PENDING_COUNT	Pending request count for requests routed to different hosts.
ROUTE_REQUEST_REJECTION_RATIO	Request rejection ratio for requests routed to different hosts.

Method Summary

Modifier and Type	Method	Description
MetricEntity	getMetricEntity()
static ClientMetricEntity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ClientMetricEntity[]	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

RETRY_CALL_COUNT

public static final ClientMetricEntity RETRY_CALL_COUNT

Client retry count.

RETRY_REQUEST_KEY_COUNT

public static final ClientMetricEntity RETRY_REQUEST_KEY_COUNT

Client retry key count.

RETRY_RESPONSE_KEY_COUNT

public static final ClientMetricEntity RETRY_RESPONSE_KEY_COUNT

Client retry response key count.

REQUEST_SERIALIZATION_TIME

public static final ClientMetricEntity REQUEST_SERIALIZATION_TIME

Request serialization time in milliseconds.

CALL_SUBMISSION_TO_HANDLING_TIME

public static final ClientMetricEntity CALL_SUBMISSION_TO_HANDLING_TIME

Time between client submitting a request and beginning to handle the response.

REQUEST_DUPLICATE_KEY_COUNT

public static final ClientMetricEntity REQUEST_DUPLICATE_KEY_COUNT

Client duplicate key count.

REQUEST_TIMEOUT_REQUESTED_DURATION

public static final ClientMetricEntity REQUEST_TIMEOUT_REQUESTED_DURATION

The timeout duration (in milliseconds) that was configured for client Future.

ROUTE_CALL_COUNT

public static final ClientMetricEntity ROUTE_CALL_COUNT

Count of all requests routed to different hosts.

ROUTE_CALL_TIME

public static final ClientMetricEntity ROUTE_CALL_TIME

Time taken for requests routed to different hosts.

ROUTE_REQUEST_PENDING_COUNT

public static final ClientMetricEntity ROUTE_REQUEST_PENDING_COUNT

Pending request count for requests routed to different hosts.

ROUTE_REQUEST_REJECTION_RATIO

public static final ClientMetricEntity ROUTE_REQUEST_REJECTION_RATIO

Request rejection ratio for requests routed to different hosts.

RESPONSE_DECOMPRESSION_TIME

public static final ClientMetricEntity RESPONSE_DECOMPRESSION_TIME

Response decompression time in milliseconds.

RESPONSE_DESERIALIZATION_TIME

public static final ClientMetricEntity RESPONSE_DESERIALIZATION_TIME

Response deserialization time in milliseconds.

RESPONSE_BATCH_STREAM_PROGRESS_TIME

public static final ClientMetricEntity RESPONSE_BATCH_STREAM_PROGRESS_TIME

Batch streaming progress time in milliseconds: Elapsed time from when the client starts receiving the response to when the first/P50th/P90th record arrives and is processed.

REQUEST_TIMEOUT_PARTIAL_RESPONSE_RATIO

public static final ClientMetricEntity REQUEST_TIMEOUT_PARTIAL_RESPONSE_RATIO

Ratio of keys that were successfully retrieved to the total number of keys requested before timeout.

REQUEST_TIMEOUT_COUNT

public static final ClientMetricEntity REQUEST_TIMEOUT_COUNT

Count of requests that timed out on the client side based on the future.get(timeout).

Method Details

values

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

getMetricEntity

public MetricEntity getMetricEntity()

Specified by:

getMetricEntity in interface ModuleMetricEntityInterface