Package com.azure.monitor.opentelemetry.autoconfigure

Class AzureMonitorAutoConfigureOptions

java.lang.Object
com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorAutoConfigureOptions
public final class AzureMonitorAutoConfigureOptions extends Object
Providers configuration options for Azure Monitor exporter..

  • Constructor Details

  • Method Details

    • pipeline

      public AzureMonitorAutoConfigureOptions pipeline(com.azure.core.http.HttpPipeline pipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      pipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.

    • httpClient

      public AzureMonitorAutoConfigureOptions httpClient(com.azure.core.http.HttpClient httpClient)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.

    • httpLogOptions

      public AzureMonitorAutoConfigureOptions httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.

    • addPolicy

      public AzureMonitorAutoConfigureOptions addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • retryOptions

      public AzureMonitorAutoConfigureOptions retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if an HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, an HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.

    • clientOptions

      public AzureMonitorAutoConfigureOptions clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.
      See Also:
      • HttpClientOptions

    • connectionString

      public AzureMonitorAutoConfigureOptions 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 AzureMonitorAutoConfigureOptions object.
      Throws:
      NullPointerException - If the connection string is null.
      IllegalArgumentException - If the connection string is invalid.

    • credential

      public AzureMonitorAutoConfigureOptions credential(com.azure.core.credential.TokenCredential credential)
      Sets the token credential required for authentication with the ingestion endpoint service.
      Parameters:
      credential - The Azure Identity TokenCredential.
      Returns:
      The updated AzureMonitorAutoConfigureOptions object.