Skip to content

Commit a242171

Browse files
authored
Update exporter/distro README (#34462)
1 parent 2ceab7c commit a242171

File tree

2 files changed

+8
-4
lines changed
  • sdk/monitor

2 files changed

+8
-4
lines changed

sdk/monitor/azure-monitor-opentelemetry-exporter/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Microsoft OpenTelemetry exporter for Azure Monitor
22

3-
The exporter for Azure Monitor allows you to export data utilizing the OpenTelemetry SDK and send telemetry data to Azure Monitor for applications written in Python.
3+
The exporter for Azure Monitor allows Python applications to export data from the OpenTelemetry SDK to Azure Monitor. The exporter is intended for users who require advanced configuration or has more complicated telemetry needs that require all of distributed tracing, logging and metrics. If you have simpler configuration requirements, we recommend using the [Azure Monitor OpenTelemetry Distro](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python) instead for a simpler one-line setup.
4+
5+
Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types). OpenTelemetry terminology differs from Application Insights terminology so it is important to understand the way the telemetry types map to each other.
46

57
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter) | [Package (PyPi)][pypi] | [API reference documentation][api_docs] | [Product documentation][product_docs] | [Samples][exporter_samples] | [Changelog](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/monitor/azure-monitor-opentelemetry-exporter/CHANGELOG.md)
68

@@ -21,7 +23,7 @@ To use this package, you must have:
2123
* Azure subscription - [Create a free account][azure_sub]
2224
* Azure Monitor - [How to use application insights][application_insights_namespace]
2325
* OpenTelemetry SDK - [OpenTelemetry SDK for Python][ot_sdk_python]
24-
* Python 3.7 or later - [Install Python][python]
26+
* Python 3.8 or later - [Install Python][python]
2527

2628
### Instantiate the client
2729

sdk/monitor/azure-monitor-opentelemetry/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Azure Monitor Opentelemetry Distro client library for Python
22

3-
The Azure Monitor Distro of [Opentelemetry Python][ot_sdk_python] provides multiple installable components available for an Opentelemetry Azure Monitor monitoring solution. It allows you to instrument your Python applications to capture and report telemetry to Azure Monitor via the Azure monitor exporters.
3+
The Azure Monitor Distro of [Opentelemetry Python][ot_sdk_python] is a "one-stop-shop" telemetry solution, requiring only one line of code to instrument your application. The distro captures telemetry via [OpenTelemetry instrumentations][azure_monitor_opentelemetry_exporters] and reports telemetry to Azure Monitor via the [Azure Monitor exporters][azure_monitor_opentelemetry_exporters].
4+
5+
Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-overview?tabs=python#telemetry-types). OpenTelemetry terminology differs from Application Insights terminology so it is important to understand the way the telemetry types map to each other.
46

57
This distro automatically installs the following libraries:
68

@@ -41,7 +43,7 @@ To use this package, you must have:
4143
* Azure subscription - [Create a free account][azure_sub]
4244
* Azure Monitor - [How to use application insights][application_insights_namespace]
4345
* Opentelemetry SDK - [Opentelemetry SDK for Python][ot_sdk_python]
44-
* Python 3.7 or later - [Install Python][python]
46+
* Python 3.8 or later - [Install Python][python]
4547

4648
### Install the package
4749

0 commit comments

Comments
 (0)