opentelemetry-python-contrib

mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-08-02 02:52:18 +08:00

Files

Andrea Galbusera 54cbf59aae Update package metadata adding "Repository" to project urls (#3119 )

Add "Repository" label to project urls pointing to the
opentelemetry-python repo root url.

Having within project urls one entry with the same value for all
packages released by the project will help tools for automatic
dependency management to suggest coherent upgrades for related packages.

2024-12-19 10:15:58 +00:00

src/opentelemetry/propagators/ot_trace

Update version to 1.30.0.dev/0.51b0.dev (#3092 )

2024-12-12 11:17:53 +00:00

tests

Fix install of Python 3.10 on GitHub Actions (#1609 )

2023-02-03 08:37:24 +05:30

pyproject.toml

Update package metadata adding "Repository" to project urls (#3119 )

2024-12-19 10:15:58 +00:00

README.rst

Add OpenTracing propagator (#302 )

2021-02-16 15:42:13 -08:00

test-requirements.txt

Remove pkg resources (#2871 )

2024-10-19 06:49:08 -07:00

README.rst

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/>`_