-
Notifications
You must be signed in to change notification settings - Fork 13
Check for undefined XRay Trace Id in AwsSdk Instrumentation #187
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
Merged
Conversation
This file contains hidden or 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
jj22ee
reviewed
Jun 2, 2025
aws-distro-opentelemetry-node-autoinstrumentation/src/patches/instrumentation-patch.ts
Outdated
Show resolved
Hide resolved
jj22ee
previously approved these changes
Jun 2, 2025
thpierce
reviewed
Jun 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add unit tests for this case?
jj22ee
reviewed
Jun 2, 2025
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
fcb7b3c
to
3b83b2b
Compare
jj22ee
reviewed
Jun 3, 2025
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
jj22ee
reviewed
Jun 3, 2025
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
aws-distro-opentelemetry-node-autoinstrumentation/test/patches/instrumentation-patch.test.ts
Outdated
Show resolved
Hide resolved
jj22ee
approved these changes
Jun 3, 2025
thpierce
approved these changes
Jun 6, 2025
jj22ee
pushed a commit
to jj22ee/aws-otel-js-instrumentation
that referenced
this pull request
Jun 14, 2025
…rvability#187) *Issue #, if available:* There is a bug where an undefined XRay Trace id is injected into the headers. However, this bug is difficult to reproduce:  The header in the export request to error out: ``` Failed to sign/authenticate the given exported Span request to OTLP XRay endpoint with error: TypeError [ERR_HTTP_INVALID_HEADER_VALUE]: Invalid value "undefined" for header "X-Amzn-Trace-Id" ``` However it's unclear whether or not this is the root-cause, for now we will add a null-safety check to mitigate any potential future bugs with this code. *Description of changes:* Added null check before injecting `AWSXRAY_TRACE_ID_HEADER` By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
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.
Issue #, if available:
There is a bug where an undefined XRay Trace id is injected into the headers. However, this bug is difficult to reproduce:

The header in the export request to error out:
However it's unclear whether or not this is the root-cause, for now we will add a null-safety check to mitigate any potential future bugs with this code.
Description of changes:
Added null check before injecting
AWSXRAY_TRACE_ID_HEADER
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.