From b4e37c11c319c0c36b787e1e8f23dd4687df29d7 Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Mon, 26 Feb 2024 14:31:09 -0800 Subject: [PATCH 1/4] readme --- .../azure-monitor-opentelemetry-exporter/README.md | 6 ++++-- sdk/monitor/azure-monitor-opentelemetry/README.md | 8 ++++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md index b1a298ae01d9..944511e0a90a 100644 --- a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md @@ -1,6 +1,8 @@ # Microsoft OpenTelemetry exporter for Azure Monitor -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. +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. This is for the Python user that wants advanced configuration or has more complicated telemetry needs that require all of distrubuted tracing, logging and metrics. For a simpler, less configurable way to send telemetry data to Azure Monitor, we recommend using [Azure Monitor OpenTelemetry Distro](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python) instead. + +Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/en-us/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. [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) @@ -21,7 +23,7 @@ To use this package, you must have: * Azure subscription - [Create a free account][azure_sub] * Azure Monitor - [How to use application insights][application_insights_namespace] * OpenTelemetry SDK - [OpenTelemetry SDK for Python][ot_sdk_python] -* Python 3.7 or later - [Install Python][python] +* Python 3.8 or later - [Install Python][python] ### Instantiate the client diff --git a/sdk/monitor/azure-monitor-opentelemetry/README.md b/sdk/monitor/azure-monitor-opentelemetry/README.md index f84ed52b9f86..1868a59eec79 100644 --- a/sdk/monitor/azure-monitor-opentelemetry/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry/README.md @@ -1,6 +1,10 @@ # Azure Monitor Opentelemetry Distro client library for Python -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. +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 as a "one-stop-shop" telemetry solution in which you only one line of code to instrument your application. + +If you require more advanced configurations than the ones available below or if you have complex telemetry scenarios, we recommend instrumenting directly with the [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters]. + +Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/en-us/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. This distro automatically installs the following libraries: @@ -41,7 +45,7 @@ To use this package, you must have: * Azure subscription - [Create a free account][azure_sub] * Azure Monitor - [How to use application insights][application_insights_namespace] * Opentelemetry SDK - [Opentelemetry SDK for Python][ot_sdk_python] -* Python 3.7 or later - [Install Python][python] +* Python 3.8 or later - [Install Python][python] ### Install the package From 0cd9dfb2b8d0c8a587f0991648c965310271de3e Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Mon, 26 Feb 2024 15:14:04 -0800 Subject: [PATCH 2/4] spelling --- sdk/monitor/azure-monitor-opentelemetry-exporter/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md index 944511e0a90a..f2cffb1a2820 100644 --- a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md @@ -1,6 +1,6 @@ # Microsoft OpenTelemetry exporter for Azure Monitor -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. This is for the Python user that wants advanced configuration or has more complicated telemetry needs that require all of distrubuted tracing, logging and metrics. For a simpler, less configurable way to send telemetry data to Azure Monitor, we recommend using [Azure Monitor OpenTelemetry Distro](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python) instead. +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. This is for the Python user that wants advanced configuration or has more complicated telemetry needs that require all of distributed tracing, logging and metrics. For a simpler, less configurable way to send telemetry data to Azure Monitor, we recommend using [Azure Monitor OpenTelemetry Distro](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python) instead. Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/en-us/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. From f4e0f3983dc2806d01de682f453458bb29575ce4 Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Tue, 27 Feb 2024 10:13:28 -0800 Subject: [PATCH 3/4] Update README.md --- sdk/monitor/azure-monitor-opentelemetry/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/monitor/azure-monitor-opentelemetry/README.md b/sdk/monitor/azure-monitor-opentelemetry/README.md index 1868a59eec79..697789c0f5f1 100644 --- a/sdk/monitor/azure-monitor-opentelemetry/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry/README.md @@ -4,7 +4,7 @@ The Azure Monitor Distro of [Opentelemetry Python][ot_sdk_python] provides multi If you require more advanced configurations than the ones available below or if you have complex telemetry scenarios, we recommend instrumenting directly with the [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters]. -Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/en-us/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. +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. This distro automatically installs the following libraries: From ffa4044e9500a1ad2c542579e11704e067f3df0b Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Tue, 27 Feb 2024 11:09:32 -0800 Subject: [PATCH 4/4] readme --- sdk/monitor/azure-monitor-opentelemetry-exporter/README.md | 4 ++-- sdk/monitor/azure-monitor-opentelemetry/README.md | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md index f2cffb1a2820..5be012c891d6 100644 --- a/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry-exporter/README.md @@ -1,8 +1,8 @@ # Microsoft OpenTelemetry exporter for Azure Monitor -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. This is for the Python user that wants advanced configuration or has more complicated telemetry needs that require all of distributed tracing, logging and metrics. For a simpler, less configurable way to send telemetry data to Azure Monitor, we recommend using [Azure Monitor OpenTelemetry Distro](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-enable?tabs=python) instead. +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. -Prior to using this SDK, please read and understand [Data Collection Basics](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-overview?tabs=python), especially the section on [telemetry types](https://learn.microsoft.com/en-us/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. +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. [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) diff --git a/sdk/monitor/azure-monitor-opentelemetry/README.md b/sdk/monitor/azure-monitor-opentelemetry/README.md index 697789c0f5f1..0b0e84515a56 100644 --- a/sdk/monitor/azure-monitor-opentelemetry/README.md +++ b/sdk/monitor/azure-monitor-opentelemetry/README.md @@ -1,8 +1,6 @@ # Azure Monitor Opentelemetry Distro client library for Python -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 as a "one-stop-shop" telemetry solution in which you only one line of code to instrument your application. - -If you require more advanced configurations than the ones available below or if you have complex telemetry scenarios, we recommend instrumenting directly with the [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters]. +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]. 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.