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.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/21/a7/19f500df5c262711ad190b24eae6a5122396ab04b1584ebb24af6d1644cc/opentelemetry_propagator_ot_trace-0.50b0.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": "Apache-2.0",
"summary": "OT Trace Propagator for OpenTelemetry",
"version": "0.50b0",
"project_urls": {
"Homepage": "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/propagator/opentelemetry-propagator-ot-trace"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2030f9a5e57d8b25cb1bb6447fa3a542d1b968fcf6ba33a6ce179c9a3863f065",
"md5": "a38b839e495d7242c535b24f84ae5814",
"sha256": "d6beac629ae674ccb454e90f3f59ce8d1a12402cc394609f72ed0bce87b3b771"
},
"downloads": -1,
"filename": "opentelemetry_propagator_ot_trace-0.50b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a38b839e495d7242c535b24f84ae5814",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4747,
"upload_time": "2024-12-11T17:05:12",
"upload_time_iso_8601": "2024-12-11T17:05:12.426677Z",
"url": "https://files.pythonhosted.org/packages/20/30/f9a5e57d8b25cb1bb6447fa3a542d1b968fcf6ba33a6ce179c9a3863f065/opentelemetry_propagator_ot_trace-0.50b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21a719f500df5c262711ad190b24eae6a5122396ab04b1584ebb24af6d1644cc",
"md5": "cfbfcf24be3429f660cd2479474b5aab",
"sha256": "4b11c05e05a64fb1a49a189f97f29f24905c7e0fec1be2b95d86e00620b26454"
},
"downloads": -1,
"filename": "opentelemetry_propagator_ot_trace-0.50b0.tar.gz",
"has_sig": false,
"md5_digest": "cfbfcf24be3429f660cd2479474b5aab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4999,
"upload_time": "2024-12-11T17:06:13",
"upload_time_iso_8601": "2024-12-11T17:06:13.470633Z",
"url": "https://files.pythonhosted.org/packages/21/a7/19f500df5c262711ad190b24eae6a5122396ab04b1584ebb24af6d1644cc/opentelemetry_propagator_ot_trace-0.50b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 17:06:13",
"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"
}
JSON
