Skip to content

Commit

Permalink
Add docs for AggregateErrors in Node.js and Browser (#7499)
Browse files Browse the repository at this point in the history
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
  • Loading branch information
lforst and shanamatthews authored Jul 31, 2023
1 parent 835f1b5 commit 069e0a4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
8 changes: 5 additions & 3 deletions src/includes/platforms/configuration/integrations/default.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,16 @@ Available options:

_Import name: `Sentry.Integrations.LinkedErrors`_

This integration allows you to configure linked errors. They’ll be recursively read up to a specified limit, and lookup will be performed by a specific key. By default, the Sentry SDK sets the limit to five and the key used is `"cause"`.
This integration allows you to configure linked errors. They'll be recursively read up to a specified limit, and a lookup will be performed by a specific key on the captured Error object. By default, the integration records up to five errors and the key used for recursion is `"cause"`.

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.

Available options:

```javascript
{
key: string;
limit: number;
key: string; // default: "cause"
limit: number; // default: 5
}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ are wrapped by our error or breadcrumb handlers.

_Import name: `Sentry.Integrations.LinkedErrors`_

This integration allows you to configure linked errors. They'll be recursively read up to a specified limit, and lookup will be performed by a specific key. By default, the limit is set to `5` and the key used is `"cause"`.
This integration allows you to configure linked errors. They'll be recursively read up to a specified limit, and a lookup will be performed by a specific key on the captured Error object. By default, the integration records up to five errors and the key used for recursion is `"cause"`.

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.

Available options:

Expand Down

1 comment on commit 069e0a4

@vercel
Copy link

@vercel vercel bot commented on 069e0a4 Jul 31, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

sentry-docs – ./

sentry-docs-git-master.sentry.dev
sentry-docs.sentry.dev
docs.sentry.io

Please sign in to comment.