Azure Monitor Opentelemetry Py

1---
2name: azure-monitor-opentelemetry-py
3description: |
4  Azure Monitor OpenTelemetry Distro for Python. Use for one-line Application Insights setup with auto-instrumentation.
5  Triggers: "azure-monitor-opentelemetry", "configure_azure_monitor", "Application Insights", "OpenTelemetry distro", "auto-instrumentation".
6package: azure-monitor-opentelemetry
7---
8 
9# Azure Monitor OpenTelemetry Distro for Python
10 
11One-line setup for Application Insights with OpenTelemetry auto-instrumentation.
12 
13## Installation
14 
15```bash
16pip install azure-monitor-opentelemetry
17```
18 
19## Environment Variables
20 
21```bash
22APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=xxx;IngestionEndpoint=https://xxx.in.applicationinsights.azure.com/
23```
24 
25## Quick Start
26 
27```python
28from azure.monitor.opentelemetry import configure_azure_monitor
29 
30# One-line setup - reads connection string from environment
31configure_azure_monitor()
32 
33# Your application code...
34```
35 
36## Explicit Configuration
37 
38```python
39from azure.monitor.opentelemetry import configure_azure_monitor
40 
41configure_azure_monitor(
42    connection_string="InstrumentationKey=xxx;IngestionEndpoint=https://xxx.in.applicationinsights.azure.com/"
43)
44```
45 
46## With Flask
47 
48```python
49from flask import Flask
50from azure.monitor.opentelemetry import configure_azure_monitor
51 
52configure_azure_monitor()
53 
54app = Flask(__name__)
55 
56@app.route("/")
57def hello():
58    return "Hello, World!"
59 
60if __name__ == "__main__":
61    app.run()
62```
63 
64## With Django
65 
66```python
67# settings.py
68from azure.monitor.opentelemetry import configure_azure_monitor
69 
70configure_azure_monitor()
71 
72# Django settings...
73```
74 
75## With FastAPI
76 
77```python
78from fastapi import FastAPI
79from azure.monitor.opentelemetry import configure_azure_monitor
80 
81configure_azure_monitor()
82 
83app = FastAPI()
84 
85@app.get("/")
86async def root():
87    return {"message": "Hello World"}
88```
89 
90## Custom Traces
91 
92```python
93from opentelemetry import trace
94from azure.monitor.opentelemetry import configure_azure_monitor
95 
96configure_azure_monitor()
97 
98tracer = trace.get_tracer(__name__)
99 
100with tracer.start_as_current_span("my-operation") as span:
101    span.set_attribute("custom.attribute", "value")
102    # Do work...
103```
104 
105## Custom Metrics
106 
107```python
108from opentelemetry import metrics
109from azure.monitor.opentelemetry import configure_azure_monitor
110 
111configure_azure_monitor()
112 
113meter = metrics.get_meter(__name__)
114counter = meter.create_counter("my_counter")
115 
116counter.add(1, {"dimension": "value"})
117```
118 
119## Custom Logs
120 
121```python
122import logging
123from azure.monitor.opentelemetry import configure_azure_monitor
124 
125configure_azure_monitor()
126 
127logger = logging.getLogger(__name__)
128logger.setLevel(logging.INFO)
129 
130logger.info("This will appear in Application Insights")
131logger.error("Errors are captured too", exc_info=True)
132```
133 
134## Sampling
135 
136```python
137from azure.monitor.opentelemetry import configure_azure_monitor
138 
139# Sample 10% of requests
140configure_azure_monitor(
141    sampling_ratio=0.1
142)
143```
144 
145## Cloud Role Name
146 
147Set cloud role name for Application Map:
148 
149```python
150from azure.monitor.opentelemetry import configure_azure_monitor
151from opentelemetry.sdk.resources import Resource, SERVICE_NAME
152 
153configure_azure_monitor(
154    resource=Resource.create({SERVICE_NAME: "my-service-name"})
155)
156```
157 
158## Disable Specific Instrumentations
159 
160```python
161from azure.monitor.opentelemetry import configure_azure_monitor
162 
163configure_azure_monitor(
164    instrumentations=["flask", "requests"]  # Only enable these
165)
166```
167 
168## Enable Live Metrics
169 
170```python
171from azure.monitor.opentelemetry import configure_azure_monitor
172 
173configure_azure_monitor(
174    enable_live_metrics=True
175)
176```
177 
178## Azure AD Authentication
179 
180```python
181from azure.monitor.opentelemetry import configure_azure_monitor
182from azure.identity import DefaultAzureCredential
183 
184configure_azure_monitor(
185    credential=DefaultAzureCredential()
186)
187```
188 
189## Auto-Instrumentations Included
190 
191| Library | Telemetry Type |
192|---------|---------------|
193| Flask | Traces |
194| Django | Traces |
195| FastAPI | Traces |
196| Requests | Traces |
197| urllib3 | Traces |
198| httpx | Traces |
199| aiohttp | Traces |
200| psycopg2 | Traces |
201| pymysql | Traces |
202| pymongo | Traces |
203| redis | Traces |
204 
205## Configuration Options
206 
207| Parameter | Description | Default |
208|-----------|-------------|---------|
209| `connection_string` | Application Insights connection string | From env var |
210| `credential` | Azure credential for AAD auth | None |
211| `sampling_ratio` | Sampling rate (0.0 to 1.0) | 1.0 |
212| `resource` | OpenTelemetry Resource | Auto-detected |
213| `instrumentations` | List of instrumentations to enable | All |
214| `enable_live_metrics` | Enable Live Metrics stream | False |
215 
216## Best Practices
217 
2181. **Call configure_azure_monitor() early** — Before importing instrumented libraries
2192. **Use environment variables** for connection string in production
2203. **Set cloud role name** for multi-service applications
2214. **Enable sampling** in high-traffic applications
2225. **Use structured logging** for better log analytics queries
2236. **Add custom attributes** to spans for better debugging
2247. **Use AAD authentication** for production workloads
225