Package com.linkedin.venice.stats

Class OpenTelemetryMetricsSetup.Builder

java.lang.Object

com.linkedin.venice.stats.OpenTelemetryMetricsSetup.Builder

Enclosing class:

OpenTelemetryMetricsSetup

public static class OpenTelemetryMetricsSetup.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(io.tehuti.metrics.MetricsRepository metricsRepository)

Method Summary

Modifier and Type	Method	Description
OpenTelemetryMetricsSetup.Builder	addCustomDimension(VeniceDimensionInterface dimensionValue)	Add a custom dimension from a VeniceDimensionInterface enum value.
OpenTelemetryMetricsSetup.OpenTelemetryMetricsSetupInfo	build()	Build: setup base dimensions and attributes, and determine if OTel metrics should be emitted.
OpenTelemetryMetricsSetup.Builder	isTotalStats(boolean isTotalStats)	Set whether this is for total stats (affects whether OTel metrics are emitted).
OpenTelemetryMetricsSetup.Builder	setClusterName(String clusterName)	Set the cluster name dimension.
OpenTelemetryMetricsSetup.Builder	setHelixGroupId(int helixGroupId)	Set the Helix group ID dimension.
OpenTelemetryMetricsSetup.Builder	setOtelEnabledOverride(boolean otelEnabledOverride)	Per-category gate for OTel metrics, applied on top of the global OTel config.
OpenTelemetryMetricsSetup.Builder	setRegionName(String regionName)	Set the region/datacenter name dimension.
OpenTelemetryMetricsSetup.Builder	setRequestRetryType(RequestRetryType requestRetryType)	Set the request retry type dimension.
OpenTelemetryMetricsSetup.Builder	setRequestType(RequestType requestType)	Set the request type dimension.
OpenTelemetryMetricsSetup.Builder	setRouteName(String routeName)	Set the route name dimension.
OpenTelemetryMetricsSetup.Builder	setStoreName(String storeName)	Set the store name dimension.
OpenTelemetryMetricsSetup.Builder	setThreadPoolName(String threadPoolName)	Set the thread pool name dimension.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(io.tehuti.metrics.MetricsRepository metricsRepository)

Method Details

setStoreName

public OpenTelemetryMetricsSetup.Builder setStoreName(String storeName)

Set the store name dimension.

setRequestType

public OpenTelemetryMetricsSetup.Builder setRequestType(RequestType requestType)

Set the request type dimension.

isTotalStats

public OpenTelemetryMetricsSetup.Builder isTotalStats(boolean isTotalStats)

Set whether this is for total stats (affects whether OTel metrics are emitted).

setOtelEnabledOverride

public OpenTelemetryMetricsSetup.Builder setOtelEnabledOverride(boolean otelEnabledOverride)

Per-category gate for OTel metrics, applied on top of the global OTel config. OTel metrics are emitted only when both the global config and this override are enabled. Setting this to false disables OTel for the stats class being built, even if the global config is enabled. Setting it to true has no effect if the global config is disabled — it cannot re-enable OTel.

setClusterName

public OpenTelemetryMetricsSetup.Builder setClusterName(String clusterName)

Set the cluster name dimension.

setRegionName

public OpenTelemetryMetricsSetup.Builder setRegionName(String regionName)

Set the region/datacenter name dimension.

setRouteName

public OpenTelemetryMetricsSetup.Builder setRouteName(String routeName)

Set the route name dimension.

setRequestRetryType

public OpenTelemetryMetricsSetup.Builder setRequestRetryType(RequestRetryType requestRetryType)

Set the request retry type dimension.

setThreadPoolName

public OpenTelemetryMetricsSetup.Builder setThreadPoolName(String threadPoolName)

Set the thread pool name dimension.

setHelixGroupId

public OpenTelemetryMetricsSetup.Builder setHelixGroupId(int helixGroupId)

Set the Helix group ID dimension.

addCustomDimension

public OpenTelemetryMetricsSetup.Builder addCustomDimension(VeniceDimensionInterface dimensionValue)

Add a custom dimension from a VeniceDimensionInterface enum value. Use this for component-specific dimensions that are not standard builder parameters (e.g., buffer type) that are used once or in a few places, to avoid bloating the builder with rarely-used parameters. The dimension key and value are derived from the enum.

Parameters:

dimensionValue - the enum value providing both dimension key and value; must not be null

Throws:

IllegalArgumentException - if dimensionValue is null

build

public OpenTelemetryMetricsSetup.OpenTelemetryMetricsSetupInfo build()

Build: setup base dimensions and attributes, and determine if OTel metrics should be emitted.

Returns:

OpenTelemetryMetricsSetupInfo containing this information