opentelemetry-propagator-aws-xray


Nameopentelemetry-propagator-aws-xray JSON
Version 1.0.2 PyPI version JSON
download
home_pageNone
SummaryAWS X-Ray Propagator for OpenTelemetry
upload_time2024-08-05 17:45:57
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            OpenTelemetry Propagator for AWS X-Ray Service
==============================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-propagator-aws-xray.svg
   :target: https://pypi.org/project/opentelemetry-propagator-aws-xray/


This library provides the propagator necessary to inject or extract a tracing
context across AWS services.

Installation
------------

::

    pip install opentelemetry-propagator-aws-xray


Usage (AWS X-Ray Propagator)
----------------------------

**NOTE**: Because the parent context extracted from the `X-Amzn-Trace-Id` header
assumes the context is _not_ sampled by default, users should make sure to add
`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are
sampled.

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:

.. code-block:: python

    from opentelemetry.propagate import set_global_textmap
    from opentelemetry.propagators.aws import AwsXRayPropagator

    set_global_textmap(AwsXRayPropagator())


References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `AWS X-Ray Propagation Trace Header <https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader>`_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "opentelemetry-propagator-aws-xray",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>",
    "download_url": "https://files.pythonhosted.org/packages/f4/31/40004e9e55b1e5694ef3a7526f0b7637df44196fc68a8b7d248a3684680f/opentelemetry_propagator_aws_xray-1.0.2.tar.gz",
    "platform": null,
    "description": "OpenTelemetry Propagator for AWS X-Ray Service\n==============================================\n\n|pypi|\n\n.. |pypi| image:: https://badge.fury.io/py/opentelemetry-propagator-aws-xray.svg\n   :target: https://pypi.org/project/opentelemetry-propagator-aws-xray/\n\n\nThis library provides the propagator necessary to inject or extract a tracing\ncontext across AWS services.\n\nInstallation\n------------\n\n::\n\n    pip install opentelemetry-propagator-aws-xray\n\n\nUsage (AWS X-Ray Propagator)\n----------------------------\n\n**NOTE**: Because the parent context extracted from the `X-Amzn-Trace-Id` header\nassumes the context is _not_ sampled by default, users should make sure to add\n`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are\nsampled.\n\nUse the provided AWS X-Ray Propagator to inject the necessary context into\ntraces sent to external systems.\n\nThis can be done by either setting this environment variable:\n\n::\n\n    export OTEL_PROPAGATORS = xray\n\n\nOr by setting this propagator in your instrumented application:\n\n.. code-block:: python\n\n    from opentelemetry.propagate import set_global_textmap\n    from opentelemetry.propagators.aws import AwsXRayPropagator\n\n    set_global_textmap(AwsXRayPropagator())\n\n\nReferences\n----------\n\n* `OpenTelemetry Project <https://opentelemetry.io/>`_\n* `AWS X-Ray Propagation Trace Header <https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader>`_\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "AWS X-Ray Propagator for OpenTelemetry",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/propagator/opentelemetry-propagator-aws-xray"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea89849a0847871fd9745315896ad9e23d6479db84d90b8b36c4c26dc46e92b8",
                "md5": "d34bbc51b702a744841eed1387c54367",
                "sha256": "1c99181ee228e99bddb638a0c911a297fa21f1c3a0af951f841e79919b5f1934"
            },
            "downloads": -1,
            "filename": "opentelemetry_propagator_aws_xray-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d34bbc51b702a744841eed1387c54367",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 10856,
            "upload_time": "2024-08-05T17:45:56",
            "upload_time_iso_8601": "2024-08-05T17:45:56.492065Z",
            "url": "https://files.pythonhosted.org/packages/ea/89/849a0847871fd9745315896ad9e23d6479db84d90b8b36c4c26dc46e92b8/opentelemetry_propagator_aws_xray-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f43140004e9e55b1e5694ef3a7526f0b7637df44196fc68a8b7d248a3684680f",
                "md5": "696739d361c7ea09db772562733bfe96",
                "sha256": "6b2cee5479d2ef0172307b66ed2ed151f598a0fd29b3c01133ac87ca06326260"
            },
            "downloads": -1,
            "filename": "opentelemetry_propagator_aws_xray-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "696739d361c7ea09db772562733bfe96",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10994,
            "upload_time": "2024-08-05T17:45:57",
            "upload_time_iso_8601": "2024-08-05T17:45:57.601003Z",
            "url": "https://files.pythonhosted.org/packages/f4/31/40004e9e55b1e5694ef3a7526f0b7637df44196fc68a8b7d248a3684680f/opentelemetry_propagator_aws_xray-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-05 17:45:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "open-telemetry",
    "github_project": "opentelemetry-python-contrib",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "opentelemetry-propagator-aws-xray"
}
        
Elapsed time: 0.28209s