Metadata-Version: 2.1
Name: opentelemetry-sdk-extension-aws
Version: 0.16b0
Summary: AWS SDK extension for OpenTelemetry
Home-page: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/master/sdk-extension/opentelemetry-sdk-extension-aws
Author: OpenTelemetry Authors
Author-email: cncf-opentelemetry-contributors@lists.cncf.io
License: Apache-2.0
Description: OpenTelemetry SDK Extension for AWS X-Ray Compatibility
        =======================================================
        
        |pypi|
        
        .. |pypi| image:: https://badge.fury.io/py/opentelemetry-sdk-extension-aws.svg
           :target: https://pypi.org/project/opentelemetry-sdk-extension-aws/
        
        
        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 `AwsXRayIdsGenerator` to initialize the `TracerProvider`.
        
        .. code-block:: python
        
            import opentelemetry.trace as trace
            from opentelemetry.sdk.extension.aws.trace import AwsXRayIdsGenerator
            from opentelemetry.sdk.trace import TracerProvider
        
            trace.set_tracer_provider(
                TracerProvider(ids_generator=AwsXRayIdsGenerator())
            )
        
        
        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:
        
        .. code-block:: python
        
            from opentelemetry import propagators
            from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat
        
            propagators.set_global_textmap(AwsXRayFormat())
        
        References
        ----------
        
        * `OpenTelemetry Project <https://opentelemetry.io/>`_
        * `AWS X-Ray Trace IDs Format <https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sendingdata.html#xray-api-traceids>`_
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Provides-Extra: test
