Class AzureMonitorExporterOptions
Options that allow users to configure the Azure Monitor Exporter.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Monitor.OpenTelemetry.Exporter.dll
Syntax
public class AzureMonitorExporterOptions : Azure.Core.ClientOptionsConstructors
AzureMonitorExporterOptions()
Initializes a new instance of the AzureMonitorExporterOptions.
Declaration
public AzureMonitorExporterOptions ();AzureMonitorExporterOptions(AzureMonitorExporterOptions+ServiceVersion)
Initializes a new instance of the AzureMonitorExporterOptions.
Declaration
public AzureMonitorExporterOptions (Azure.Monitor.OpenTelemetry.Exporter.AzureMonitorExporterOptions.ServiceVersion version = Azure.Monitor.OpenTelemetry.Exporter.AzureMonitorExporterOptions+ServiceVersion.v2_1);Parameters
|
AzureMonitorExporterOptions.ServiceVersion
version
The AzureMonitorExporterOptions.ServiceVersion of the Azure Monitor ingestion API. |
Properties
ConnectionString
The Connection String provides users with a single configuration setting to identify the Azure Monitor resource and endpoint.
Declaration
public string ConnectionString { get; set; }Property Value
|
System.String
|
Remarks
Credential
Get or sets the value of Azure.Core.TokenCredential.
Declaration
public Azure.Core.TokenCredential Credential { get; set; }Property Value
|
Azure.Core.TokenCredential
|
DisableOfflineStorage
Disable offline storage.
Declaration
public bool DisableOfflineStorage { get; set; }Property Value
|
System.Boolean
|
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.
This setting is applicable only when UseAzureMonitorExporter API is used.
.
Declaration
public bool EnableLiveMetrics { get; set; }Property Value
|
System.Boolean
|
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.
Declaration
public float SamplingRatio { get; set; }Property Value
|
System.Single
|
StorageDirectory
Override the default directory for offline storage.
Declaration
public string StorageDirectory { get; set; }Property Value
|
System.String
|
Version
The AzureMonitorExporterOptions.ServiceVersion of the Azure Monitor ingestion API.
Declaration
public Azure.Monitor.OpenTelemetry.Exporter.AzureMonitorExporterOptions.ServiceVersion Version { get; set; }Property Value
|
AzureMonitorExporterOptions.ServiceVersion
|