fix: 16-bit hexadecimal formatting for XCTC span IDs #946
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
the
api: logging
daniel-sanche
approved these changes
Oct 11, 2024
| if span_id_int > 0 and span_id_int < 2**64: | ||
| span_id = f"{span_id_int:016x}" | ||
| else: | ||
| span_id = None |
There was a problem hiding this comment.
nit: maybe raise an exception here, since we already have the try/catch?
try:
span_id_int = int(span_id)
if span_id_int < 0 or span_id_int > 2**64:
raise ValueError("span_id outside valid range")
span_id = f"{span_id_int:016x}"
except ValueError:
span_id = None
|
|
||
| # Convert the span ID to 16-bit hexadecimal instead of decimal | ||
| if span_id is not None: | ||
| try: |
There was a problem hiding this comment.
You have a lot of layers of nesting here... consider splitting this up into multiple smaller helper functions. For example:
xctc_trace_id, xctc_span_id, xctc_options = _parse_xct_header(header)
trace_id = _validate_and_normalize_xctc_trace_id(xctc_trace_id)
span_id = _validate_and_normalize_xctc_span_id(xctc_span_id)
sampled = _extract_should_sample_from_xctc_option(xctc_options)
| if span_id_int > 0 and span_id_int < 2**64: | ||
| span_id = f"{span_id_int:016x}" | ||
| else: | ||
| span_id = None |
There was a problem hiding this comment.
If parts of the header fail to validate, you may want to consider making it more obvious that this has happened. Consider some form of debug logging or other tracking if not propagated an error to the caller.
tests/unit/handlers/test__helpers.py
Outdated
| for input_span in input_spans: | ||
| expected_trace = "12345" | ||
| input_span = "67890" | ||
| expected_span = "10932".zfill(16) |
There was a problem hiding this comment.
Why is this the expected span when the input span is invalid? Shouldn't the expected span be None?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #942
Also updated link to comment for XCTC formatting, as that seems to have been moved prior.