Package com.linkedin.venice.client.stats

Class BasicClientStats

java.lang.Object

com.linkedin.venice.stats.AbstractVeniceStats

com.linkedin.venice.stats.AbstractVeniceHttpStats

com.linkedin.venice.client.stats.BasicClientStats

Direct Known Subclasses:

ClientStats

public class BasicClientStats
extends AbstractVeniceHttpStats

This class offers some base metrics for clients currently used by thin, fast and DaVinci clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BasicClientStats.BasicClientMetricEntity
static enum	BasicClientStats.BasicClientTehutiMetricName	Metric names for tehuti metrics used in this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.opentelemetry.api.common.Attributes	baseAttributes
protected final Map<VeniceMetricsDimensions,String>	baseDimensionsMap
static final Collection<MetricEntity>	CLIENT_METRIC_ENTITIES
protected final ClientType	clientType
protected final VeniceOpenTelemetryMetricsRepository	otelRepository

Fields inherited from class com.linkedin.venice.stats.AbstractVeniceStats

DELIMITER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicClientStats(io.tehuti.metrics.MetricsRepository metricsRepository, String storeName, RequestType requestType, ClientType clientType)

Method Summary

Modifier and Type	Method	Description
void	emitHealthyRequestMetricsForDavinciClient(double latency)
void	emitHealthyRequestMetricsNonDavinciClient(double latency, int successfulKeyCount, int requestedKeyCount)	Records healthy request metrics, bucketing the call_time OTel metric by the originally-requested key count (not the successful count).
protected boolean	emitOpenTelemetryMetrics()
void	emitUnhealthyRequestMetricsForDavinciClient(double latency)
void	emitUnhealthyRequestMetricsNonDavinciClient(double latency, int httpStatus, int requestedKeyCount)
void	emitUnhealthyRequestMetricsNonDavinciClient(double latency, Throwable throwable, int requestedKeyCount)
protected io.opentelemetry.api.common.Attributes	getBaseAttributes()
static BasicClientStats	getClientStats(io.tehuti.metrics.MetricsRepository metricsRepository, String storeName, RequestType requestType, ClientConfig clientConfig, ClientType clientType)
static int	getHealthyRequestHttpStatus(int numSuccessfulKeys)	Get the HTTP status code for healthy requests based on the number of successful keys as both null and valid values are considered healthy in Venice.
static List<Class<? extends ModuleMetricEntityInterface>>	getMetricEntityEnumClasses()	Returns the enum classes that compose CLIENT_METRIC_ENTITIES.
protected final io.tehuti.metrics.stats.Rate	getRequestRate()
static int	getSuccessfulKeyCount(Object value)	Get the number of successful keys from the value.
protected final io.tehuti.metrics.stats.Rate	getSuccessRequestKeyCountRate()
static int	getUnhealthyRequestHttpStatus(Throwable throwable)	Get the HTTP status code for unhealthy requests based on the throwable.
void	recordRequestKeyCount(int keyCount)
void	recordResponseKeyCount(int keyCount)

Methods inherited from class com.linkedin.venice.stats.AbstractVeniceHttpStats

getFullMetricName, getRequestType, registerSensor, registerSensor, registerSensor, registerSensorWithDetailedPercentiles

Methods inherited from class com.linkedin.venice.stats.AbstractVeniceStats

avgAndMax, avgAndTotal, getMetricFullName, getMetricsRepository, getName, getSensorFullName, getSensorFullName, isTotalStats, minAndMax, registerOnlyTotalRate, registerOnlyTotalSensor, registerPerStoreAndTotal, registerPerStoreAndTotalSensor, registerSensor, registerSensorAttributeGauge, registerSensorIfAbsent, registerSensorIfAbsent, registerSensorIfAbsent, registerSensorWithAggregate, registerSensorWithAggregate, unregisterAllSensors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLIENT_METRIC_ENTITIES

public static final Collection<MetricEntity> CLIENT_METRIC_ENTITIES

baseDimensionsMap

protected final Map<VeniceMetricsDimensions,String> baseDimensionsMap

baseAttributes

protected final io.opentelemetry.api.common.Attributes baseAttributes

otelRepository

protected final VeniceOpenTelemetryMetricsRepository otelRepository

clientType

protected final ClientType clientType

Constructor Details

BasicClientStats

protected BasicClientStats(io.tehuti.metrics.MetricsRepository metricsRepository,
 String storeName,
 RequestType requestType,
 ClientType clientType)

Method Details

getMetricEntityEnumClasses

public static List<Class<? extends ModuleMetricEntityInterface>> getMetricEntityEnumClasses()

Returns the enum classes that compose CLIENT_METRIC_ENTITIES. This is the single source of truth used by both production aggregation and tests.

getClientStats

public static BasicClientStats getClientStats(io.tehuti.metrics.MetricsRepository metricsRepository,
 String storeName,
 RequestType requestType,
 ClientConfig clientConfig,
 ClientType clientType)

emitHealthyRequestMetricsNonDavinciClient

public void emitHealthyRequestMetricsNonDavinciClient(double latency,
 int successfulKeyCount,
 int requestedKeyCount)

Records healthy request metrics, bucketing the call_time OTel metric by the originally-requested key count (not the successful count).

emitUnhealthyRequestMetricsNonDavinciClient

public void emitUnhealthyRequestMetricsNonDavinciClient(double latency,
 int httpStatus,
 int requestedKeyCount)

emitUnhealthyRequestMetricsNonDavinciClient

public void emitUnhealthyRequestMetricsNonDavinciClient(double latency,
 Throwable throwable,
 int requestedKeyCount)

emitHealthyRequestMetricsForDavinciClient

public void emitHealthyRequestMetricsForDavinciClient(double latency)

emitUnhealthyRequestMetricsForDavinciClient

public void emitUnhealthyRequestMetricsForDavinciClient(double latency)

recordRequestKeyCount

public void recordRequestKeyCount(int keyCount)

recordResponseKeyCount

public void recordResponseKeyCount(int keyCount)

getRequestRate

protected final io.tehuti.metrics.stats.Rate getRequestRate()

getSuccessRequestKeyCountRate

protected final io.tehuti.metrics.stats.Rate getSuccessRequestKeyCountRate()

getHealthyRequestHttpStatus

public static int getHealthyRequestHttpStatus(int numSuccessfulKeys)

Get the HTTP status code for healthy requests based on the number of successful keys as both null and valid values are considered healthy in Venice.

Parameters:

numSuccessfulKeys -

Returns:

HttpStatus

getSuccessfulKeyCount

public static int getSuccessfulKeyCount(Object value)

Get the number of successful keys from the value.

Parameters:

value -

Returns:

The number of successful keys.

getUnhealthyRequestHttpStatus

public static int getUnhealthyRequestHttpStatus(Throwable throwable)

Get the HTTP status code for unhealthy requests based on the throwable.

Parameters:

throwable -

Returns:

HttpStatus

getBaseAttributes

protected io.opentelemetry.api.common.Attributes getBaseAttributes()

emitOpenTelemetryMetrics

protected boolean emitOpenTelemetryMetrics()