Package io.grpc.opentelemetry

Class GrpcOpenTelemetry.Builder

java.lang.Object

io.grpc.opentelemetry.GrpcOpenTelemetry.Builder

Enclosing class:

GrpcOpenTelemetry

public static class GrpcOpenTelemetry.Builder
extends Object

Builder for configuring GrpcOpenTelemetry.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	disableAll
private final Map<String,Boolean>	enableMetrics
private io.opentelemetry.api.OpenTelemetry	openTelemetrySdk
private final Collection<String>	optionalLabels
private final List<OpenTelemetryPlugin>	plugins

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
GrpcOpenTelemetry.Builder	addOptionalLabel(String optionalLabelKey)	Adds optionalLabelKey to all the metrics that can provide value for the optionalLabelKey.
GrpcOpenTelemetry	build()	Returns a new GrpcOpenTelemetry built with the configuration of this GrpcOpenTelemetry.Builder.
GrpcOpenTelemetry.Builder	disableAllMetrics()	Disable all metrics.
GrpcOpenTelemetry.Builder	disableMetrics(Collection<String> disableMetrics)	Disables the specified metrics from being collected and exported.
GrpcOpenTelemetry.Builder	enableMetrics(Collection<String> enableMetrics)	Enables the specified metrics for collection and export.
(package private) GrpcOpenTelemetry.Builder	enableTracing(boolean enable)
(package private) GrpcOpenTelemetry.Builder	plugin(OpenTelemetryPlugin plugin)
GrpcOpenTelemetry.Builder	sdk(io.opentelemetry.api.OpenTelemetry sdk)	Sets the OpenTelemetry entrypoint to use.

Methods inherited from class java.lang.Object

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

Field Details

openTelemetrySdk

private io.opentelemetry.api.OpenTelemetry openTelemetrySdk

plugins

private final List<OpenTelemetryPlugin> plugins

optionalLabels

private final Collection<String> optionalLabels

enableMetrics

private final Map<String,Boolean> enableMetrics

disableAll

private boolean disableAll

Constructor Details

Builder

private Builder()

Method Details

sdk

public GrpcOpenTelemetry.Builder sdk(io.opentelemetry.api.OpenTelemetry sdk)

Sets the OpenTelemetry entrypoint to use. This can be used to configure OpenTelemetry by returning the instance created by a io.opentelemetry.sdk.OpenTelemetrySdkBuilder.

plugin

GrpcOpenTelemetry.Builder plugin(OpenTelemetryPlugin plugin)

addOptionalLabel

public GrpcOpenTelemetry.Builder addOptionalLabel(String optionalLabelKey)

Adds optionalLabelKey to all the metrics that can provide value for the optionalLabelKey.

enableMetrics

public GrpcOpenTelemetry.Builder enableMetrics(Collection<String> enableMetrics)

Enables the specified metrics for collection and export. By default, only a subset of metrics are enabled.

disableMetrics

public GrpcOpenTelemetry.Builder disableMetrics(Collection<String> disableMetrics)

Disables the specified metrics from being collected and exported.

disableAllMetrics

public GrpcOpenTelemetry.Builder disableAllMetrics()

Disable all metrics. If set to true all metrics must be explicitly enabled.

enableTracing

GrpcOpenTelemetry.Builder enableTracing(boolean enable)

build

public GrpcOpenTelemetry build()

Returns a new GrpcOpenTelemetry built with the configuration of this GrpcOpenTelemetry.Builder.