Skip to content

Commit b0fc2c2

Browse files
committed
Update README.md
1 parent b756968 commit b0fc2c2

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

azure-monitor-opentelemetry/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This distro automatically installs the following libraries:
66

77
* [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters]
88

9+
as well as a subset of OpenTelemetry [instrumentations][ot_instrumentations] that are officially supported as listed below.
10+
911
## Officially supported instrumentations
1012

1113
OpenTelemetry instrumentations allow automatic collection of requests sent from underlying instrumented libraries. The following is a list of OpenTelemetry instrumentations that come bundled in with the Azure monitor distro. If you would like to add support for another OpenTelemetry instrumentation, please submit a feature [request][distro_feature_request]. In the meantime, you can use the OpenTelemetry instrumentation manually via it's own APIs (i.e. `instrument()`) in your code. See [this][samples_manual] for an example.
@@ -63,8 +65,14 @@ You can use `configure_azure_monitor` to set up instrumentation for your app to
6365
...
6466
configure_azure_monitor(
6567
connection_string="<your-connection-string>",
66-
flask_config={"excluded_urls": "http://localhost:8080/ignore"},
67-
requests_config={"excluded_urls": "http://example.com"},
68+
instrumentation_config={
69+
"flask": {
70+
"excluded_urls": "http://localhost:8080/ignore",
71+
},
72+
"requests": {
73+
"excluded_urls": "http://example.com"
74+
}
75+
}
6876
)
6977
...
7078
```
@@ -99,16 +107,18 @@ Samples are available [here][samples] to demonstrate how to utilize the above co
99107

100108
### Additional documentation
101109

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

105114
<!-- LINKS -->
115+
[azure_monitor_opentelemetry]: https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python
106116
[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
107117
[azure_portal]: https://portal.azure.com
108118
[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
119+
[application_insights_namespace]: https://learn.microsoft.com/azure/azure-monitor/app/app-insights-overview
120+
[application_insights_sampling]: https://learn.microsoft.com/azure/azure-monitor/app/sampling
121+
[connection_string_doc]: https://learn.microsoft.com/azure/azure-monitor/app/sdk-connection-string
112122
[distro_feature_request]: https://github.com/microsoft/ApplicationInsights-Python/issues/new
113123
[exporter_configuration_docs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter#configuration
114124
[logging_level]: https://docs.python.org/3/library/logging.html#levels

0 commit comments

Comments
 (0)