Microsoft Azure Azure Core OpenTelemetry plugin Library for Python
Azure Core Tracing OpenTelemetry client library for Python
Install the package
Install the Azure Core OpenTelemetry Tracing plugin 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.
You don't need to pass any context, SDK will get it for you
There are two ways to enable the tracing plugin in code:
from azure.core.settings import settings from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan settings.tracing_implementation = OpenTelemetrySpan
from azure.core.settings import settings settings.tracing_implementation = "opentelemetry"
Alternatively, if you have the latest version of
azure-coreinstalled, you can also set the following environment variable to enable tracing with OpenTelemetry:
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 SDKs from azure.core.settings import settings settings.tracing_implementation = "opentelemetry" # In the below example, we use a simple console exporter, uncomment these lines to use # the OpenTelemetry exporter for Azure Monitor. # Example of a trace exporter for Azure Monitor, but you can use anything OpenTelemetry supports # from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter # exporter = AzureMonitorTraceExporter( # connection_string="the connection string used for your Application Insights resource" # ) # Regular open telemetry usage from here, see https://github.com/open-telemetry/opentelemetry-python # for details from opentelemetry import trace from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ConsoleSpanExporter from opentelemetry.sdk.trace.export import SimpleSpanProcessor # Simple console exporter exporter = ConsoleSpanExporter() trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer(__name__) trace.get_tracer_provider().add_span_processor( SimpleSpanProcessor(exporter) ) # Example with Storage SDKs from azure.storage.blob import BlobServiceClient with tracer.start_as_current_span(name="MyApplication"): client = BlobServiceClient.from_connection_string('connectionstring') client.create_container('my_container') # Call will be traced
The Azure Monitor OpenTelemetry Exporter can be found in the
With the Azure Core OpenTelemetry Tracing plugin enabled, HTTP requests made by Azure SDK clients are typically instrumented via the
DistributedTracingPolicy automatically. Since Azure Core handles HTTP instrumentation for Azure service calls, automatic HTTP instrumentation from other libraries such as
opentelemetry-requests-instrumentation are suppressed to avoid duplicate spans from being created.
This client raises exceptions defined in Azure Core.
More documentation on OpenTelemetry configuration can be found on the OpenTelemetry website
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 https://cla.microsoft.com.
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.
OpenTelemetrySpantyping to correctly implement the
- Enabled the use of the
contextkeyword argument for passing in context headers of a parent span. This will be the parent context used when creating the span. (#30411)
- Remapped certain attributes to converge with OpenTelemetry semantic conventions (#29203):
- Python 2.7 is no longer supported. Please use Python version 3.7 or later.
- Nested internal spans are now suppressed with just the outermost internal span being recorded. Nested client spans will be children of the outermost span. (#29616)
- When client spans are created, a flag is set to indicate that automatic HTTP instrumentation should be suppressed. Since azure-core already instruments HTTP calls, this prevents duplicate spans from being produced. (#29616)
- Schema URL is now set on the tracer's instrumentation scope. (#30014)
opentelemetry-apidependency bumped to
azure-coredependency bumped to
- Updated opentelemetry-api to version 1.0.0
SpanKindcan now be added while creating the span instance.
- Pinned opentelemetry-api to version 0.17b0
- Pinned opentelemetry-api to version 0.13b0
- Pinned opentelemetry-api to version 0.10b0
- Pinned opentelemetry-api to version 0.8b0
- Fixed a bug where
DefaultSpansometimes throws an AttributeError.
link_from_headersnow accepts attributes.
- Pinned opentelemetry-api to version 0.6b0
- Pinned opentelemetry-api to version 0.4a0
- Opentelemetry implementation of azure-core tracing protocol
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for azure-core-tracing-opentelemetry-1.0.0b11.tar.gz
Hashes for azure_core_tracing_opentelemetry-1.0.0b11-py3-none-any.whl