AzureMonitorOptions Class

Definition

Namespace:

Azure.Monitor.OpenTelemetry.AspNetCore

Assembly:

Azure.Monitor.OpenTelemetry.AspNetCore.dll

Package:

Azure.Monitor.OpenTelemetry.AspNetCore v1.2.0

Source:

AzureMonitorOptions.cs

Options that allow users to configure the Azure Monitor.

public class AzureMonitorOptions : Azure.Core.ClientOptions

type AzureMonitorOptions = class
    inherit ClientOptions

Public Class AzureMonitorOptions
Inherits ClientOptions

Inheritance

Object

ClientOptions

AzureMonitorOptions

Constructors

AzureMonitorOptions()

Initializes a new instance of the AzureMonitorOptions.

Properties

ConnectionString	The Connection String provides users with a single configuration setting to identify the Azure Monitor resource and endpoint.
Credential	Get or sets the value of TokenCredential. If TokenCredential is not set, AAD authentication is disabled and Instrumentation Key from the Connection String will be used.
Diagnostics	Gets the client diagnostic options. (Inherited from ClientOptions)
DisableOfflineStorage	Disable offline storage.
EnableLiveMetrics	Enables or disables the Live Metrics feature. This property is enabled by default. Note: Enabling Live Metrics incurs no additional billing or costs. However, it does introduce a performance overhead due to extra data collection, processing, and networking calls. This overhead is only significant when the LiveMetrics portal is actively used in the UI. Once the portal is closed, LiveMetrics reverts to a 'silent' mode with minimal to no overhead. https://learn.microsoft.com/azure/azure-monitor/app/live-stream?tabs=dotnet6.
Retry	Gets the client retry options. (Inherited from ClientOptions)
RetryPolicy	Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values. (Inherited from ClientOptions)
SamplingRatio	Gets or sets the ratio of telemetry items to be sampled. The value must be between 0.0F and 1.0F, inclusive. For example, specifying 0.4 means that 40% of traces are sampled and 60% are dropped. The default value is 1.0F, indicating that all telemetry items are sampled.
StorageDirectory	Override the default directory for offline storage.
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object. (Inherited from ClientOptions)