Package com.azure.monitor.opentelemetry.exporter

Class AzureMonitorExporterBuilder

java.lang.Object

com.azure.monitor.opentelemetry.exporter.AzureMonitorExporterBuilder

public final class AzureMonitorExporterBuilder
extends Object

This class provides a fluent builder API to instantiate AzureMonitorTraceExporter that implements SpanExporter interface defined by OpenTelemetry API specification.

Constructor Summary

Constructors

Constructor	Description
AzureMonitorExporterBuilder()	Creates an instance of AzureMonitorExporterBuilder.

Method Summary

Modifier and Type	Method	Description
AzureMonitorExporterBuilder	addPolicy(HttpPipelinePolicy policy)	Adds a policy to the set of existing policies that are executed after required policies.
AzureMonitorTraceExporter	buildTraceExporter()	Creates an AzureMonitorTraceExporter based on the options set in the builder.
AzureMonitorExporterBuilder	clientOptions(ClientOptions clientOptions)	Sets the client options such as application ID and custom headers to set on a request.
AzureMonitorExporterBuilder	configuration(Configuration configuration)	Sets the configuration store that is used during construction of the service client.
AzureMonitorExporterBuilder	connectionString(String connectionString)	Sets the connection string to use for exporting telemetry events to Azure Monitor.
AzureMonitorExporterBuilder	credential(TokenCredential credential)	Sets the token credential required for authentication with the ingestion endpoint service.
AzureMonitorExporterBuilder	httpClient(HttpClient client)	Sets the HTTP client to use for sending and receiving requests to and from the service.
AzureMonitorExporterBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration for HTTP requests and responses.
AzureMonitorExporterBuilder	pipeline(HttpPipeline httpPipeline)	Sets the HTTP pipeline to use for the service client.
AzureMonitorExporterBuilder	retryPolicy(RetryPolicy retryPolicy)	Sets the RetryPolicy that is used when each request is sent.
AzureMonitorExporterBuilder	serviceVersion(AzureMonitorExporterServiceVersion serviceVersion)	Sets the Azure Monitor service version.

Methods inherited from class java.lang.Object

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

Constructor Details

AzureMonitorExporterBuilder

public AzureMonitorExporterBuilder()

Creates an instance of AzureMonitorExporterBuilder.

Method Details

pipeline

public AzureMonitorExporterBuilder pipeline(HttpPipeline httpPipeline)

Sets the HTTP pipeline to use for the service client. If pipeline is set, all other settings are ignored, apart from endpoint.

Parameters:

httpPipeline - The HTTP pipeline to use for sending service requests and receiving responses.

Returns:

The updated AzureMonitorExporterBuilder object.

httpClient

public AzureMonitorExporterBuilder httpClient(HttpClient client)

Sets the HTTP client to use for sending and receiving requests to and from the service.

Parameters:

client - The HTTP client to use for requests.

Returns:

The updated AzureMonitorExporterBuilder object.

httpLogOptions

public AzureMonitorExporterBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the logging configuration for HTTP requests and responses.

If logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

The updated AzureMonitorExporterBuilder object.

retryPolicy

public AzureMonitorExporterBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy that is used when each request is sent.

The default retry policy will be used if not provided to build AzureMonitorExporterBuilder .

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated AzureMonitorExporterBuilder object.

addPolicy

public AzureMonitorExporterBuilder addPolicy(HttpPipelinePolicy policy)

Adds a policy to the set of existing policies that are executed after required policies.

Parameters:

policy - The retry policy for service requests.

Returns:

The updated AzureMonitorExporterBuilder object.

Throws:

NullPointerException - If policy is null.

configuration

public AzureMonitorExporterBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client.

The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to

Returns:

The updated AzureMonitorExporterBuilder object.

clientOptions

public AzureMonitorExporterBuilder clientOptions(ClientOptions clientOptions)

Sets the client options such as application ID and custom headers to set on a request.

Parameters:

clientOptions - The client options.

Returns:

The updated AzureMonitorExporterBuilder object.

connectionString

public AzureMonitorExporterBuilder connectionString(String connectionString)

Sets the connection string to use for exporting telemetry events to Azure Monitor.

Parameters:

connectionString - The connection string for the Azure Monitor resource.

Returns:

The updated AzureMonitorExporterBuilder object.

Throws:

NullPointerException - If the connection string is null.

IllegalArgumentException - If the connection string is invalid.

serviceVersion

public AzureMonitorExporterBuilder serviceVersion(AzureMonitorExporterServiceVersion serviceVersion)

Sets the Azure Monitor service version.

Parameters:

serviceVersion - The Azure Monitor service version.

Returns:

The update AzureMonitorExporterBuilder object.

credential

public AzureMonitorExporterBuilder credential(TokenCredential credential)

Sets the token credential required for authentication with the ingestion endpoint service.

Parameters:

credential - The Azure Identity TokenCredential.

Returns:

The updated AzureMonitorExporterBuilder object.

buildTraceExporter

public AzureMonitorTraceExporter buildTraceExporter()

Creates an AzureMonitorTraceExporter based on the options set in the builder. This exporter is an implementation of OpenTelemetry SpanExporter.

Returns:

An instance of AzureMonitorTraceExporter.

Throws:

NullPointerException - if the connection string is not set on this builder or if the environment variable "APPLICATIONINSIGHTS_CONNECTION_STRING" is not set.