Azure Monitor Opentelemetry Distro

The Azure Monitor Distro of Opentelemetry 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.

This distro automatically installs the following libraries:

• Azure Monitor OpenTelemetry exporters
• A subset of OpenTelemetry instrumentations that are officially supported as listed below.

Officially supported instrumentations

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. In the meantime, you can use the OpenTelemetry instrumentation manually via it's own APIs (i.e. instrument()) in your code. See this for an example.

Getting started

Key Concepts

This package bundles a series of OpenTelemetry and Azure Monitor components to enable the collection and sending of telemetry to Azure Monitor. For MANUAL instrumentation, use the configure_azure_monitor function. AUTOMATIC instrumentation is not yet supported.

The Azure Monitor OpenTelemetry exporters are the main components in accomplishing this. You will be able to use the exporters and their APIs directly through this package. Please go the exporter documentation to understand how OpenTelemetry and Azure Monitor components work in enabling telemetry collection and exporting.

Currently, all instrumentations available in OpenTelemetry are in a beta state, meaning they are not stable and may have breaking changes in the future. Efforts are being made in pushing these to a more stable state.

Prerequisites

To use this package, you must have:

• Azure subscription - Create a free account
• Azure Monitor - How to use application insights
• Opentelemetry SDK - Opentelemetry SDK for Python
• Python 3.7 or later - Install Python

Install the package

Install the Azure Monitor Opentelemetry Distro with pip:

pip install azure-monitor-opentelemetry --pre

Usage

You can use configure_azure_monitor to set up instrumentation for your app to Azure Monitor. configure_azure_monitor supports the following optional arguments:

Example for use of instrumentation_config:

...
configure_azure_monitor(
    connection_string="<your-connection-string>",
    instrumentation_config={
        "flask": {
            "excluded_urls": "http://localhost:8080/ignore",
        },
        "requests": {
            "excluded_urls": "http://example.com"
        }
    }
)
...

Take a look at the specific instrumenation documentation for available configurations.

Azure monitor OpenTelemetry Exporter configurations

You can pass Azure monitor OpenTelemetry exporter configuration parameters directly into configure_azure_monitor. See additional configuration related to exporting here.

...
configure_azure_monitor(
   connection_string="<your-connection-string>",
   disable_offline_storage=True, 
)
...

Samples

Samples are available here to demonstrate how to utilize the above configuration options.

Additional documentation

• Azure Portal
• Official Azure monitor docs
• OpenTelemetry Python Official Docs