Azure Monitor Opentelemetry Exporter Py

1---
2name: azure-monitor-opentelemetry-exporter-py
3description: |
4  Azure Monitor OpenTelemetry Exporter for Python. Use for low-level OpenTelemetry export to Application Insights.
5  Triggers: "azure-monitor-opentelemetry-exporter", "AzureMonitorTraceExporter", "AzureMonitorMetricExporter", "AzureMonitorLogExporter".
6package: azure-monitor-opentelemetry-exporter
7---
8 
9# Azure Monitor OpenTelemetry Exporter for Python
10 
11Low-level exporter for sending OpenTelemetry traces, metrics, and logs to Application Insights.
12 
13## Installation
14 
15```bash
16pip install azure-monitor-opentelemetry-exporter
17```
18 
19## Environment Variables
20 
21```bash
22APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=xxx;IngestionEndpoint=https://xxx.in.applicationinsights.azure.com/
23```
24 
25## When to Use
26 
27| Scenario | Use |
28|----------|-----|
29| Quick setup, auto-instrumentation | `azure-monitor-opentelemetry` (distro) |
30| Custom OpenTelemetry pipeline | `azure-monitor-opentelemetry-exporter` (this) |
31| Fine-grained control over telemetry | `azure-monitor-opentelemetry-exporter` (this) |
32 
33## Trace Exporter
34 
35```python
36from opentelemetry import trace
37from opentelemetry.sdk.trace import TracerProvider
38from opentelemetry.sdk.trace.export import BatchSpanProcessor
39from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
40 
41# Create exporter
42exporter = AzureMonitorTraceExporter(
43    connection_string="InstrumentationKey=xxx;..."
44)
45 
46# Configure tracer provider
47trace.set_tracer_provider(TracerProvider())
48trace.get_tracer_provider().add_span_processor(
49    BatchSpanProcessor(exporter)
50)
51 
52# Use tracer
53tracer = trace.get_tracer(__name__)
54with tracer.start_as_current_span("my-span"):
55    print("Hello, World!")
56```
57 
58## Metric Exporter
59 
60```python
61from opentelemetry import metrics
62from opentelemetry.sdk.metrics import MeterProvider
63from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
64from azure.monitor.opentelemetry.exporter import AzureMonitorMetricExporter
65 
66# Create exporter
67exporter = AzureMonitorMetricExporter(
68    connection_string="InstrumentationKey=xxx;..."
69)
70 
71# Configure meter provider
72reader = PeriodicExportingMetricReader(exporter, export_interval_millis=60000)
73metrics.set_meter_provider(MeterProvider(metric_readers=[reader]))
74 
75# Use meter
76meter = metrics.get_meter(__name__)
77counter = meter.create_counter("requests_total")
78counter.add(1, {"route": "/api/users"})
79```
80 
81## Log Exporter
82 
83```python
84import logging
85from opentelemetry._logs import set_logger_provider
86from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
87from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
88from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter
89 
90# Create exporter
91exporter = AzureMonitorLogExporter(
92    connection_string="InstrumentationKey=xxx;..."
93)
94 
95# Configure logger provider
96logger_provider = LoggerProvider()
97logger_provider.add_log_record_processor(BatchLogRecordProcessor(exporter))
98set_logger_provider(logger_provider)
99 
100# Add handler to Python logging
101handler = LoggingHandler(level=logging.INFO, logger_provider=logger_provider)
102logging.getLogger().addHandler(handler)
103 
104# Use logging
105logger = logging.getLogger(__name__)
106logger.info("This will be sent to Application Insights")
107```
108 
109## From Environment Variable
110 
111Exporters read `APPLICATIONINSIGHTS_CONNECTION_STRING` automatically:
112 
113```python
114from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
115 
116# Connection string from environment
117exporter = AzureMonitorTraceExporter()
118```
119 
120## Azure AD Authentication
121 
122```python
123from azure.identity import DefaultAzureCredential
124from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
125 
126exporter = AzureMonitorTraceExporter(
127    credential=DefaultAzureCredential()
128)
129```
130 
131## Sampling
132 
133Use `ApplicationInsightsSampler` for consistent sampling:
134 
135```python
136from opentelemetry.sdk.trace import TracerProvider
137from opentelemetry.sdk.trace.sampling import ParentBasedTraceIdRatio
138from azure.monitor.opentelemetry.exporter import ApplicationInsightsSampler
139 
140# Sample 10% of traces
141sampler = ApplicationInsightsSampler(sampling_ratio=0.1)
142 
143trace.set_tracer_provider(TracerProvider(sampler=sampler))
144```
145 
146## Offline Storage
147 
148Configure offline storage for retry:
149 
150```python
151from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
152 
153exporter = AzureMonitorTraceExporter(
154    connection_string="...",
155    storage_directory="/path/to/storage",  # Custom storage path
156    disable_offline_storage=False  # Enable retry (default)
157)
158```
159 
160## Disable Offline Storage
161 
162```python
163exporter = AzureMonitorTraceExporter(
164    connection_string="...",
165    disable_offline_storage=True  # No retry on failure
166)
167```
168 
169## Sovereign Clouds
170 
171```python
172from azure.identity import AzureAuthorityHosts, DefaultAzureCredential
173from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
174 
175# Azure Government
176credential = DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_GOVERNMENT)
177exporter = AzureMonitorTraceExporter(
178    connection_string="InstrumentationKey=xxx;IngestionEndpoint=https://xxx.in.applicationinsights.azure.us/",
179    credential=credential
180)
181```
182 
183## Exporter Types
184 
185| Exporter | Telemetry Type | Application Insights Table |
186|----------|---------------|---------------------------|
187| `AzureMonitorTraceExporter` | Traces/Spans | requests, dependencies, exceptions |
188| `AzureMonitorMetricExporter` | Metrics | customMetrics, performanceCounters |
189| `AzureMonitorLogExporter` | Logs | traces, customEvents |
190 
191## Configuration Options
192 
193| Parameter | Description | Default |
194|-----------|-------------|---------|
195| `connection_string` | Application Insights connection string | From env var |
196| `credential` | Azure credential for AAD auth | None |
197| `disable_offline_storage` | Disable retry storage | False |
198| `storage_directory` | Custom storage path | Temp directory |
199 
200## Best Practices
201 
2021. **Use BatchSpanProcessor** for production (not SimpleSpanProcessor)
2032. **Use ApplicationInsightsSampler** for consistent sampling across services
2043. **Enable offline storage** for reliability in production
2054. **Use AAD authentication** instead of instrumentation keys
2065. **Set export intervals** appropriate for your workload
2076. **Use the distro** (`azure-monitor-opentelemetry`) unless you need custom pipelines
208