AWS SDK extension for OpenTelemetry
Project description
This library provides components necessary to configure the OpenTelemetry SDK for tracing with AWS X-Ray.
Installation
pip install opentelemetry-sdk-extension-aws
Usage (AWS X-Ray IDs Generator)
Configure the OTel SDK TracerProvider with the provided custom IDs Generator to make spans compatible with the AWS X-Ray backend tracing service.
Install the OpenTelemetry SDK package.
pip install opentelemetry-sdk
Next, use the provided AwsXRayIdGenerator to initialize the TracerProvider.
import opentelemetry.trace as trace
from opentelemetry.sdk.extension.aws.trace import AwsXRayIdGenerator
from opentelemetry.sdk.trace import TracerProvider
trace.set_tracer_provider(
TracerProvider(id_generator=AwsXRayIdGenerator())
)
Usage (AWS X-Ray Propagator)
Use the provided AWS X-Ray Propagator to inject the necessary context into traces sent to external systems.
This can be done by either setting this environment variable:
export OTEL_PROPAGATORS = xray
Or by setting this propagator in your instrumented application:
from opentelemetry.propagate import set_global_textmap
from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat
set_global_textmap(AwsXRayFormat())
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for opentelemetry-sdk-extension-aws-0.23b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 562ecbf3e996d770753e63b9524dbea920f7ff806d5a78eef8cdac4ca76db8bf |
|
MD5 | ced5d909c0ed23767d187e34e889b449 |
|
BLAKE2b-256 | 4f31449a2ac678c9ea46e575bb5cd0e74aaf708e5b9620ec2ac47608346e1070 |
Hashes for opentelemetry_sdk_extension_aws-0.23b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86c223c7fe49235cc5564df9c2e0c3a5689ed5c2c9754b97195fbf1660d77f34 |
|
MD5 | a74188faa51a197d1b8ceb040b61ce46 |
|
BLAKE2b-256 | b37e020314de3e8ddeb9fd7a9c63b528b51e17f23aa5ee77549f5fef16c370e2 |