Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add some clarity to ottrace docs #522

Merged
merged 6 commits into from
Jul 7, 2023

Conversation

arielvalentin
Copy link
Collaborator

Fixes #521

propagator/ottrace/README.md Outdated Show resolved Hide resolved
Co-authored-by: Matthew Wear <matthew.wear@gmail.com>
@arielvalentin
Copy link
Collaborator Author

@mwear hold on... I committed your changes a little too soon

This propagator is compatible with 8 or 16 byte trace ids which it normalizes to 16 bytes but only emits 8 byte trace ids.

8 bytes (64 bit) or 16 bytes (128 bit) extract but always 8 bytes (64 bit) inject

@mwear
Copy link
Member

mwear commented Jul 7, 2023

8 bytes (64 bit) or 16 bytes (128 bit) extract but always 8 bytes (64 bit) inject

☝️ is correct. I'm not sure if we should clarify the inject vs extract case, if you just want to go with what we originally had (before my suggestion).


In order to do that Lightstep released a version of the OTTrace propagators in OpenTracing SDKs that left padded 8 byte headers to 16 bytes using an additional 8 bytes of 0s.

The reality of the world is not every application upgraded to support 16 byte array propagation format, but this propagator must still convert legacy 8 byte trace ids to match the W3C Trace Context Trace ID 16 byte array.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The reality of the world is not every application upgraded to support 16 byte array propagation format, but this propagator must still convert legacy 8 byte trace ids to match the W3C Trace Context Trace ID 16 byte array.
The reality of the world is not every application upgraded to support 16 byte array propagation format, but this propagator must still convert legacy 64 but trace ids to match the W3C Trace Context Trace ID 16 byte array.

propagator/ottrace/README.md Outdated Show resolved Hide resolved
mwear and others added 3 commits July 7, 2023 13:51
Co-authored-by: Ariel Valentin <arielvalentin@users.noreply.github.com>
Co-authored-by: Ariel Valentin <arielvalentin@users.noreply.github.com>
Co-authored-by: Matthew Wear <matthew.wear@gmail.com>
@arielvalentin arielvalentin merged commit 0f868b7 into open-telemetry:main Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OTTrace trace ID seem to require 32 char instead of 16
2 participants