feat(js): Add docs about serialization of captureException objects #14256
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
AbhiPrasad
approved these changes
Jul 3, 2025
Bundle ReportChanges will increase total bundle size by 180 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
andreiborza
approved these changes
Jul 3, 2025
BYK
reviewed
Jul 7, 2025
| // --> "Object captured as exception with keys: prop1, prop2" | ||
| ``` | ||
|
|
||
| Note that built-in objects may be serialized differently. If you want to capture objects in a specific way, you can use the `captureContext` parameter to attach additional data to the event. |
There was a problem hiding this comment.
Maybe provide an example for the HTTP Response objects for demonstration? Would also help LLMs as a 1-shot prompt 😅
coolguyzone
reviewed
Jul 7, 2025
| @@ -239,6 +239,16 @@ more information on how to use integrations. | |||
| only `Error` objects, but also other objects as `exception` - in that case, | |||
| the SDK will attempt to serialize the object for you, and the stack trace will | |||
| be generated by the SDK and may be less accurate. | |||
|
|
|||
| Please note that the serialization of objects may not be perfect, as it works based on simple heuristics. Objects that are not `Error` objects will be generally be serialized as follows: | |||
There was a problem hiding this comment.
Suggested change
| Please note that the serialization of objects may not be perfect, as it works based on simple heuristics. Objects that are not `Error` objects will be generally be serialized as follows: | |
| Please note that the serialization of objects may not be perfect, as it's based on simple heuristics. Objects that are not `Error` objects will be generally be serialized as follows: |
coolguyzone
reviewed
Jul 7, 2025
|
|
||
| ```javascript | ||
| Sentry.captureException({ prop1: "value1", prop2: "value2" }); | ||
| // --> "Object captured as exception with keys: prop1, prop2" |
There was a problem hiding this comment.
Suggested change
| // --> "Object captured as exception with keys: prop1, prop2" | |
| // --> "Object captured as an exception with keys: prop1, prop2" |
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.
This adds docs explaining how
captureExceptionhandles different kinds of objects.Closes https://linear.app/getsentry/issue/FE-507/improve-js-sdk-based-on-user-feedback