Azure Core Tracing OpenTelemetry client library for Python — Azure SDK for Python 2.0.0 documentation

Getting started¶

Install the package¶

Install the opentelemetry python for Python with pip:

pip install azure-core-tracing-opentelemetry

Now you can use opentelemetry for Python as usual with any SDKs that are compatible with azure-core tracing. This includes (not exhaustive list), azure-storage-blob, azure-keyvault-secrets, azure-eventhub, etc.

Key concepts¶

You don’t need to pass any context, SDK will get it for you

Those lines are the only ones you need to enable tracing

from azure.core.settings import settingsfrom azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpansettings.tracing_implementation = OpenTelemetrySpan

Examples¶

There is no explicit context to pass, you just create your usual opentelemetry tracer and call any SDK code that is compatible with azure-core tracing. This is an example using Azure Monitor exporter, but you can use any exporter (Zipkin, etc.).

# Declare OpenTelemetry as enabled tracing plugin for Azure SDKsfrom azure.core.settings import settingsfrom azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpansettings.tracing_implementation = OpenTelemetrySpan# In the below example, we use a simple console exporter, uncomment these lines to use# the Azure Monitor Exporter.# Example of Azure Monitor exporter, but you can use anything OpenTelemetry supports# from azure_monitor import AzureMonitorSpanExporter# exporter = AzureMonitorSpanExporter(# instrumentation_key="uuid of the instrumentation key (see your Azure Monitor account)"# )# Regular open telemetry usage from here, see # for detailsfrom opentelemetry import tracefrom opentelemetry.sdk.trace import TracerProviderfrom opentelemetry.sdk.trace.export import ConsoleSpanExporterfrom opentelemetry.sdk.trace.export import SimpleExportSpanProcessor# Simple console exporterexporter = ConsoleSpanExporter()trace.set_tracer_provider(TracerProvider())tracer = trace.get_tracer(__name__)trace.get_tracer_provider().add_span_processor( SimpleExportSpanProcessor(exporter))# Example with Storage SDKsfrom azure.storage.blob import BlobServiceClientwith tracer.start_as_current_span(name="MyApplication"): client = BlobServiceClient.from_connection_string('connectionstring') client.create_container('mycontainer') # Call will be traced

Azure Exporter can be found in the package opentelemetry-azure-monitor-exporter

Troubleshooting¶

This client raises exceptions defined in Azure Core.

Contributing¶

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit .

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.