docs: document unwrapError utility and error unwrapping in spans
#1908
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
- Add unwrapError to import example - Document automatic error cause chain unwrapping in setSpanWithError - Add section on using unwrapError utility directly - Update summary to mention automatic error unwrapping behavior
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Updates the Spans and Traces documentation to reflect the new error unwrapping functionality introduced in PR #1907.
Changes
unwrapErrorexportsetSpanWithErrorautomatically unwraps nested.causechains to surface root cause errorsContext
PR #1907 introduces a new
unwrapErrorutility function that traverses error.causechains to find root cause errors. This is particularly useful because Node.jsfetch()wraps underlying errors (like undici'sHeadersTimeoutError) in genericTypeError: fetch failedmessages. ThesetSpanWithErrorfunction now automatically uses this utility to record root cause errors in spans.Related to #1907
cc @shagun-singh-inkeep for review