Package com.azure.core.tracing.opentelemetry

Class OpenTelemetryTracingOptions

java.lang.Object

com.azure.core.util.TracingOptions

com.azure.core.tracing.opentelemetry.OpenTelemetryTracingOptions

public class OpenTelemetryTracingOptions
extends TracingOptions

OpenTelemetry-specific Azure SDK tracing options.

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryTracingOptions()	Creates an instance of OpenTelemetryTracingOptions.

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.api.trace.TracerProvider	getProvider()	Gets implementation-specific state containing all configuration needed for the implementation such as OpenTelemetry MeterProvider.
OpenTelemetrySchemaVersion	getSchemaVersion()	Gets schema version.
OpenTelemetryTracingOptions	setProvider(io.opentelemetry.api.trace.TracerProvider provider)	Sets implementation-specific state containing all configuration needed for the implementation such as OpenTelemetry MeterProvider.
OpenTelemetryTracingOptions	setSchemaVersion(OpenTelemetrySchemaVersion schemaVersion)	Sets schema version.

Methods inherited from class com.azure.core.util.TracingOptions

fromConfiguration, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

OpenTelemetryTracingOptions

public OpenTelemetryTracingOptions()

Creates an instance of OpenTelemetryTracingOptions.

Method Details

getProvider

public io.opentelemetry.api.trace.TracerProvider getProvider()

Gets implementation-specific state containing all configuration needed for the implementation such as OpenTelemetry MeterProvider. Check out OpenTelemetry Metrics plugin documentation for the details and examples.

Returns:

the value of implementation-specific metric provider, null by default.

setProvider

public OpenTelemetryTracingOptions setProvider(io.opentelemetry.api.trace.TracerProvider provider)

Sets implementation-specific state containing all configuration needed for the implementation such as OpenTelemetry MeterProvider. Check out OpenTelemetry Metrics plugin documentation for the details and examples.

 // configure OpenTelemetry SDK explicitly per https://opentelemetry.io/docs/instrumentation/java/manual/
 SdkTracerProvider tracerProvider = SdkTracerProvider.builder()
     .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
     .build();

 // Pass OpenTelemetry tracerProvider to TracingOptions.
 TracingOptions customTracingOptions = new OpenTelemetryTracingOptions()
     .setProvider(tracerProvider);

 // configure Azure Client to use customTracingOptions - it will use tracerProvider
 // to create tracers
 AzureClient sampleClient = new AzureClientBuilder()
     .endpoint("https://my-client.azure.com")
     .clientOptions(new ClientOptions().setTracingOptions(customTracingOptions))
     .build();

 // use client as usual, if it emits spans, they will be exported
 sampleClient.methodCall("get items");

 

Parameters:

provider - Instance of TracerProvider

Returns:

the updated MetricsOptions object.

getSchemaVersion

public OpenTelemetrySchemaVersion getSchemaVersion()

Gets schema version.

Returns:

schema version.

setSchemaVersion

public OpenTelemetryTracingOptions setSchemaVersion(OpenTelemetrySchemaVersion schemaVersion)

Sets schema version.

Parameters:

schemaVersion - schema version.

Returns:

updated OpenTelemetryTracingOptions.