Skip to content

Add docs for AggregateErrors in Node.js and Browser - #7499

Merged
lforst merged 7 commits into
masterfrom
lforst-document-js-aggregate-errors
Jul 31, 2023
Merged

Add docs for AggregateErrors in Node.js and Browser#7499
lforst merged 7 commits into
masterfrom
lforst-document-js-aggregate-errors

Conversation

@lforst

@lforst lforst commented Jul 25, 2023

Copy link
Copy Markdown
Contributor

Documents changes from getsentry/sentry-javascript#8463 where we implemented support for AggregateErrors in the JS SDK.

@vercel

vercel Bot commented Jul 25, 2023

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 31, 2023 8:05am


<PlatformContent includePath="configuration/linked-errors" />

Additionally, the `LinkedErrors` integration enhances the capturing of [AggregateErrors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) by recursively iterating over the `errors` property on Error objects.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Additionally, the `LinkedErrors` integration enhances the capturing of [AggregateErrors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) by recursively iterating over the `errors` property on Error objects.
This integration also captures [AggregateErrors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) by recursively iterating over the `errors` property on Error objects.

Does this reword make sense? This sentence didn't make sense to me as written. Does iterating over the errors property mean that the integration won't use the given key to recurse?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could we move this up higher, above available options, so it's not missed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Does this reword make sense? This sentence didn't make sense to me as written. Does iterating over the errors property mean that the integration won't use the given key to recurse?

I originally had something similar but I was actually very specific with my wording because this integration doesn't capture any errors. It just enhances already captured error events with additional data.

Could we move this up higher, above available options, so it's not missed?

For sure!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ahh, I see.

Maybe we could phrase it more like how you explained it to me here then:

Suggested change
Additionally, the `LinkedErrors` integration enhances the capturing of [AggregateErrors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) by recursively iterating over the `errors` property on Error objects.
This integration also enhances captured error events with data from an [AggregateError](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) where applicable, by recursively iterating over the `errors` property on Error objects.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I like this! Thank you! :)

Comment thread src/includes/platforms/configuration/integrations/default.mdx Outdated
Comment thread src/platforms/node/common/configuration/integrations/default-integrations.mdx Outdated
}
```

Additionally, the `LinkedErrors` integration enhances the capturing of [AggregateErrors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError) by recursively iterating over the `errors` property on Error objects.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same comment

Luca Forstner and others added 3 commits July 26, 2023 11:38
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
…ntegrations.mdx

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
@getsantry
getsantry Bot requested a review from a team as a code owner July 26, 2023 09:40
@lforst
lforst merged commit 069e0a4 into master Jul 31, 2023
@lforst
lforst deleted the lforst-document-js-aggregate-errors branch July 31, 2023 08:26
shanamatthews added a commit that referenced this pull request Jul 31, 2023
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants