opentelemetry-propagator-ot-trace


Nameopentelemetry-propagator-ot-trace JSON
Version 0.56b0 PyPI version JSON
download
home_pageNone
SummaryOT Trace Propagator for OpenTelemetry
upload_time2025-07-11 12:26:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            OpenTelemetry OT Trace Propagator
=================================

|pypi|

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

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

::

    pip install opentelemetry-propagator-ot-trace

.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/

OTTrace Format
--------------

So far there is no "formal" specification of the OTTrace format. The best
document that servers this purpose that exists now is this_ implementation.

.. _this: https://github.com/opentracing/basictracer-python/blob/master/basictracer/text_propagator.py

===================== ======================================================================================================================================= =====================
Header Name           Description                                                                                                                             Required
===================== ======================================================================================================================================= =====================
``ot-tracer-traceid`` uint64 encoded as a string of 16 hex characters                                                                                         yes
``ot-tracer-spanid``  uint64 encoded as a string of 16 hex characters                                                                                         yes
``ot-tracer-sampled`` boolean encoded as a string with the values ``true`` or ``false``                                                                       no
``ot-baggage-*``      repeated string to string key-value baggage items; keys are prefixed with ``ot-baggage-`` and the corresponding value is the raw string if baggage is present
===================== ======================================================================================================================================= =====================

Interop and trace ids
---------------------

The OT Trace propagation format expects trace ids to be 64-bits. In order to
interop with OpenTelemetry, trace ids need to be truncated to 64-bits before
sending them on the wire. When truncating, the least significant (right-most)
bits MUST be retained. For example, a trace id of
``3c3039f4d78d5c02ee8e3e41b17ce105`` would be truncated to
``ee8e3e41b17ce105``.

References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "opentelemetry-propagator-ot-trace",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>",
    "download_url": "https://files.pythonhosted.org/packages/60/07/dbf84f7df020cfe3acbb2dc1cf8b153c2e910b29e4469221b15cdc46d532/opentelemetry_propagator_ot_trace-0.56b0.tar.gz",
    "platform": null,
    "description": "OpenTelemetry OT Trace Propagator\n=================================\n\n|pypi|\n\n.. |pypi| image:: https://badge.fury.io/py/opentelemetry-propagator-ot-trace.svg\n   :target: https://pypi.org/project/opentelemetry-propagator-ot-trace/\n\nInstallation\n------------\n\n::\n\n    pip install opentelemetry-propagator-ot-trace\n\n.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/\n\nOTTrace Format\n--------------\n\nSo far there is no \"formal\" specification of the OTTrace format. The best\ndocument that servers this purpose that exists now is this_ implementation.\n\n.. _this: https://github.com/opentracing/basictracer-python/blob/master/basictracer/text_propagator.py\n\n===================== ======================================================================================================================================= =====================\nHeader Name           Description                                                                                                                             Required\n===================== ======================================================================================================================================= =====================\n``ot-tracer-traceid`` uint64 encoded as a string of 16 hex characters                                                                                         yes\n``ot-tracer-spanid``  uint64 encoded as a string of 16 hex characters                                                                                         yes\n``ot-tracer-sampled`` boolean encoded as a string with the values ``true`` or ``false``                                                                       no\n``ot-baggage-*``      repeated string to string key-value baggage items; keys are prefixed with ``ot-baggage-`` and the corresponding value is the raw string if baggage is present\n===================== ======================================================================================================================================= =====================\n\nInterop and trace ids\n---------------------\n\nThe OT Trace propagation format expects trace ids to be 64-bits. In order to\ninterop with OpenTelemetry, trace ids need to be truncated to 64-bits before\nsending them on the wire. When truncating, the least significant (right-most)\nbits MUST be retained. For example, a trace id of\n``3c3039f4d78d5c02ee8e3e41b17ce105`` would be truncated to\n``ee8e3e41b17ce105``.\n\nReferences\n----------\n\n* `OpenTelemetry Project <https://opentelemetry.io/>`_\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "OT Trace Propagator for OpenTelemetry",
    "version": "0.56b0",
    "project_urls": {
        "Homepage": "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/propagator/opentelemetry-propagator-ot-trace",
        "Repository": "https://github.com/open-telemetry/opentelemetry-python-contrib"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d36d51401fb47b0f3fbd3674ee0a2cdf792921f44f6440423d9af33ff144eb6b",
                "md5": "471e36aa3a43de522b7494e1fb922157",
                "sha256": "03b8d89d468e32998f0e4b28c9b8e5a20d9269c809cbb643f5e3e8413737dce9"
            },
            "downloads": -1,
            "filename": "opentelemetry_propagator_ot_trace-0.56b0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "471e36aa3a43de522b7494e1fb922157",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4764,
            "upload_time": "2025-07-11T12:26:14",
            "upload_time_iso_8601": "2025-07-11T12:26:14.499970Z",
            "url": "https://files.pythonhosted.org/packages/d3/6d/51401fb47b0f3fbd3674ee0a2cdf792921f44f6440423d9af33ff144eb6b/opentelemetry_propagator_ot_trace-0.56b0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6007dbf84f7df020cfe3acbb2dc1cf8b153c2e910b29e4469221b15cdc46d532",
                "md5": "a227c1051895681b45c359bbef48f3ee",
                "sha256": "ee88be295c093b3901239e6185d3a885d65d2d648f11f3efd42f0a8a05e38f01"
            },
            "downloads": -1,
            "filename": "opentelemetry_propagator_ot_trace-0.56b0.tar.gz",
            "has_sig": false,
            "md5_digest": "a227c1051895681b45c359bbef48f3ee",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5014,
            "upload_time": "2025-07-11T12:26:54",
            "upload_time_iso_8601": "2025-07-11T12:26:54.328016Z",
            "url": "https://files.pythonhosted.org/packages/60/07/dbf84f7df020cfe3acbb2dc1cf8b153c2e910b29e4469221b15cdc46d532/opentelemetry_propagator_ot_trace-0.56b0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-11 12:26:54",
    "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-ot-trace"
}
        
Elapsed time: 0.41161s