Skip to content

Commit fd58832

Browse files
authored
Merge pull request #261 from lzchen/docs
2 parents b756968 + 8865888 commit fd58832

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

azure-monitor-opentelemetry/README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The Azure Monitor Distro of [Opentelemetry Python][ot_sdk_python] provides multi
55
This distro automatically installs the following libraries:
66

77
* [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters]
8+
* A subset of OpenTelemetry [instrumentations][ot_instrumentations] that are officially supported as listed below.
89

910
## Officially supported instrumentations
1011

@@ -63,8 +64,14 @@ You can use `configure_azure_monitor` to set up instrumentation for your app to
6364
...
6465
configure_azure_monitor(
6566
connection_string="<your-connection-string>",
66-
flask_config={"excluded_urls": "http://localhost:8080/ignore"},
67-
requests_config={"excluded_urls": "http://example.com"},
67+
instrumentation_config={
68+
"flask": {
69+
"excluded_urls": "http://localhost:8080/ignore",
70+
},
71+
"requests": {
72+
"excluded_urls": "http://example.com"
73+
}
74+
}
6875
)
6976
...
7077
```
@@ -99,16 +106,18 @@ Samples are available [here][samples] to demonstrate how to utilize the above co
99106

100107
### Additional documentation
101108

102-
[Azure Portal][azure_portal]
103-
[OpenTelemetry Python Official Docs][ot_python_docs]
109+
* [Azure Portal][azure_portal]
110+
* [Official Azure monitor docs][azure_monitor_opentelemetry]
111+
* [OpenTelemetry Python Official Docs][ot_python_docs]
104112

105113
<!-- LINKS -->
114+
[azure_monitor_opentelemetry]: https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python
106115
[azure_monitor_opentelemetry_exporters]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter#microsoft-opentelemetry-exporter-for-azure-monitor
107116
[azure_portal]: https://portal.azure.com
108117
[azure_sub]: https://azure.microsoft.com/free/
109-
[application_insights_namespace]: https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview
110-
[application_insights_sampling]: https://learn.microsoft.com/en-us/azure/azure-monitor/app/sampling
111-
[connection_string_doc]: https://learn.microsoft.com/en-us/azure/azure-monitor/app/sdk-connection-string
118+
[application_insights_namespace]: https://learn.microsoft.com/azure/azure-monitor/app/app-insights-overview
119+
[application_insights_sampling]: https://learn.microsoft.com/azure/azure-monitor/app/sampling
120+
[connection_string_doc]: https://learn.microsoft.com/azure/azure-monitor/app/sdk-connection-string
112121
[distro_feature_request]: https://github.com/microsoft/ApplicationInsights-Python/issues/new
113122
[exporter_configuration_docs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter#configuration
114123
[logging_level]: https://docs.python.org/3/library/logging.html#levels

0 commit comments

Comments
 (0)