Description

# Microsoft OpenTelemetry exporter for Azure Monitor 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 have 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/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) ## Getting started ### Install the package Install the Microsoft OpenTelemetry exporter for Azure Monitor with [pip][pip]: ```Bash pip install azure-monitor-opentelemetry-exporter --pre ``` ### Prerequisites 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.8 or later - [Install Python][python] ### Instantiate the client Interaction with Azure monitor exporter starts with an instance of the `AzureMonitorTraceExporter` class for distributed tracing, `AzureMonitorLogExporter` for logging and `AzureMonitorMetricExporter` for metrics. You will need a **connection_string** to instantiate the object. Please find the samples linked below for demonstration as to how to construct the exporter using a connection string. #### Logging (experimental) NOTE: The logging signal for the `AzureMonitorLogExporter` is currently in an EXPERIMENTAL state. Possible breaking changes may ensue in the future. ```python from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter exporter = AzureMonitorLogExporter( connection_string=os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"] ) ``` #### Metrics ```python from azure.monitor.opentelemetry.exporter import AzureMonitorMetricExporter exporter = AzureMonitorMetricExporter( connection_string=os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"] ) ``` #### Tracing ```python from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter exporter = AzureMonitorTraceExporter( connection_string=os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"] ) ``` You can also instantiate the exporter directly via the constructor. In this case, the connection string will be automatically populated from the `APPLICATIONINSIGHTS_CONNECTION_STRING` environment variable. ```python from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter exporter = AzureMonitorLogExporter() ``` ```python from azure.monitor.opentelemetry.exporter import AzureMonitorMetricExporter exporter = AzureMonitorMetricExporter() ``` ```python from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter exporter = AzureMonitorTraceExporter() ``` ## Key concepts Some of the key concepts for the Azure monitor exporter include: * [OpenTelemetry][opentelemetry_spec]: OpenTelemetry is a set of libraries used to collect and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior. * [Instrumentation][instrumentation_library]: The ability to call the OpenTelemetry API directly by any application is facilitated by instrumentation. A library that enables OpenTelemetry observability for another library is called an instrumentation Library. * [Log][log_concept]: Log refers to capturing of logging, exception and events. * [LogRecord][log_record]: Represents a log record emitted from a supported logging library. * [Logger][logger]: Converts a `LogRecord` into a readable `LogData`, and will be pushed through the SDK to be exported. * [Logger Provider][logger_provider]: Provides a `Logger` for the given instrumentation library. * [LogRecordProcessor][log_record_processor]: Interface to hook the log record emitting action. * [LoggingHandler][logging_handler]: A handler class which writes logging records in OpenTelemetry format from the standard Python `logging` library. * [Azu