Skip to main content

AWS SDK extension for OpenTelemetry

Project description

pypi

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 = aws_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


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

File details

Details for the file opentelemetry-sdk-extension-aws-0.19b0.tar.gz.

File metadata

  • Download URL: opentelemetry-sdk-extension-aws-0.19b0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for opentelemetry-sdk-extension-aws-0.19b0.tar.gz
Algorithm Hash digest
SHA256 3ee128e9344262d3200fb20d4f1bf0a730d9e7844b33da3f602e08c2dbc3e460
MD5 e18e2177d5a91ddf03484d1f54c6947f
BLAKE2b-256 ab2e0c1f20417664422c74caa62bb2121b9b81ebb9e6a1d84c78fc11e2c56b49

See more details on using hashes here.

File details

Details for the file opentelemetry_sdk_extension_aws-0.19b0-py3-none-any.whl.

File metadata

  • Download URL: opentelemetry_sdk_extension_aws-0.19b0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for opentelemetry_sdk_extension_aws-0.19b0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f10d61e7dcb7700784fe35a0344a4abf417dd9c964bdbcedf0ea5946d1035d2
MD5 8ea9e2dd973a8d7a1bd03361bffc0bc4
BLAKE2b-256 9f24871ca1560e071d1c00ad9fa37a3add2f736de483f03ca7f2d5e1464fd7f1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page