Skip to content
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

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

Merged
merged 7 commits into from
Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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"`.

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.

Available options:

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

Expand Down
10 changes: 9 additions & 1 deletion src/platforms/apple/common/install/carthage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ To integrate Sentry into your Xcode project using Carthage, specify it in your _
github "getsentry/sentry-cocoa" "{{@inject packages.version('sentry.cocoa') }}"
```

Run `carthage update` to download the framework and drag the built _Sentry.framework_ into your Xcode project. We also provide a pre-built version for every release, which can be downloaded at [releases on GitHub](https://github.com/getsentry/sentry-cocoa/releases).
Run `carthage update` to download the framework and drag the built _Sentry.xcframework_ into your Xcode project. We also provide a pre-built version for every release, which can be downloaded at [releases on GitHub](https://github.com/getsentry/sentry-cocoa/releases).

Sentry's Carthage setup generates 3 different frameworks:

- Sentry
- SentryPrivate
- SentrySwiftUI

_Sentry_ is required for all projects. _SentrySwiftUI_ is required to measure the performance of your SwiftUI views. _SentryPrivate_ is only needed if you changed the carthage build process to generate static frameworks.

## Macs with Apple Silicon and XCFrameworks

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"`.

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.

Available options:

Expand Down