From b73d79dcf2ed6082050e058ca8d364ad14f582f7 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 25 Jul 2023 14:28:12 +0200 Subject: [PATCH 1/7] Add docs for AggregateErrors in Node.js and Browser --- .../platforms/configuration/integrations/default.mdx | 8 +++++--- .../configuration/integrations/default-integrations.mdx | 4 +++- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/includes/platforms/configuration/integrations/default.mdx b/src/includes/platforms/configuration/integrations/default.mdx index 49b94f6f263a49..60b8f80fde2a16 100644 --- a/src/includes/platforms/configuration/integrations/default.mdx +++ b/src/includes/platforms/configuration/integrations/default.mdx @@ -89,14 +89,14 @@ 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 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 recurstion is `"cause"`. Available options: ```javascript { - key: string; - limit: number; + key: string; // default: "cause" + limit: number; // default: 5 } ``` @@ -104,6 +104,8 @@ Here is a code example of how this could be implemented: +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. + ### HttpContext _(Previously: `UserAgent`)_ diff --git a/src/platforms/node/common/configuration/integrations/default-integrations.mdx b/src/platforms/node/common/configuration/integrations/default-integrations.mdx index 53f4973c727ff8..70cbde907a207b 100644 --- a/src/platforms/node/common/configuration/integrations/default-integrations.mdx +++ b/src/platforms/node/common/configuration/integrations/default-integrations.mdx @@ -31,7 +31,7 @@ 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 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 recurstion is `"cause"`. Available options: @@ -42,6 +42,8 @@ Available options: } ``` +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. + ## Node-specific ### Console From b9251063ac254a940786ad4d3dd616170ea684c3 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 26 Jul 2023 11:38:39 +0200 Subject: [PATCH 2/7] Update src/includes/platforms/configuration/integrations/default.mdx Co-authored-by: Shana Matthews --- src/includes/platforms/configuration/integrations/default.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/includes/platforms/configuration/integrations/default.mdx b/src/includes/platforms/configuration/integrations/default.mdx index 60b8f80fde2a16..2b35056995e0de 100644 --- a/src/includes/platforms/configuration/integrations/default.mdx +++ b/src/includes/platforms/configuration/integrations/default.mdx @@ -89,7 +89,7 @@ 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 on the captured Error object. By default, the integration records up to five errors and the key used for recurstion 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"`. Available options: From 528fb2caca91a5b45d7752d97f6dce034480b007 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 26 Jul 2023 11:38:47 +0200 Subject: [PATCH 3/7] Update src/platforms/node/common/configuration/integrations/default-integrations.mdx Co-authored-by: Shana Matthews --- .../common/configuration/integrations/default-integrations.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/node/common/configuration/integrations/default-integrations.mdx b/src/platforms/node/common/configuration/integrations/default-integrations.mdx index 70cbde907a207b..54dc5f1d84d8b0 100644 --- a/src/platforms/node/common/configuration/integrations/default-integrations.mdx +++ b/src/platforms/node/common/configuration/integrations/default-integrations.mdx @@ -31,7 +31,7 @@ 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 on the captured Error object. By default, the integration records up to five errors and the key used for recurstion 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"`. Available options: From c566091c9eea1be7dada43fd0abf5fbfbf1cd27d Mon Sep 17 00:00:00 2001 From: "getsantry[bot]" <66042841+getsantry[bot]@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:40:17 +0000 Subject: [PATCH 4/7] style(lint): Auto commit lint changes --- src/platforms/apple/common/install/carthage.mdx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/platforms/apple/common/install/carthage.mdx b/src/platforms/apple/common/install/carthage.mdx index c1782890c2b63f..12fce9df7d60d4 100644 --- a/src/platforms/apple/common/install/carthage.mdx +++ b/src/platforms/apple/common/install/carthage.mdx @@ -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 From 7d7caa7fee8e0816fd9acf32fd27218090c91423 Mon Sep 17 00:00:00 2001 From: "getsantry[bot]" <66042841+getsantry[bot]@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:40:21 +0000 Subject: [PATCH 5/7] style(lint): Auto commit lint changes From 1140ed64c381ead85db71a46e9083a487ac40901 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 26 Jul 2023 11:40:49 +0200 Subject: [PATCH 6/7] Move --- src/includes/platforms/configuration/integrations/default.mdx | 4 ++-- .../configuration/integrations/default-integrations.mdx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/includes/platforms/configuration/integrations/default.mdx b/src/includes/platforms/configuration/integrations/default.mdx index 2b35056995e0de..3047d0897d82f3 100644 --- a/src/includes/platforms/configuration/integrations/default.mdx +++ b/src/includes/platforms/configuration/integrations/default.mdx @@ -91,6 +91,8 @@ _Import name: `Sentry.Integrations.LinkedErrors`_ 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 @@ -104,8 +106,6 @@ Here is a code example of how this could be implemented: -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. - ### HttpContext _(Previously: `UserAgent`)_ diff --git a/src/platforms/node/common/configuration/integrations/default-integrations.mdx b/src/platforms/node/common/configuration/integrations/default-integrations.mdx index 54dc5f1d84d8b0..8b424e16448c6b 100644 --- a/src/platforms/node/common/configuration/integrations/default-integrations.mdx +++ b/src/platforms/node/common/configuration/integrations/default-integrations.mdx @@ -33,6 +33,8 @@ _Import name: `Sentry.Integrations.LinkedErrors`_ 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 @@ -42,8 +44,6 @@ Available options: } ``` -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. - ## Node-specific ### Console From ce982e6e07945804713f1989aee5038f34df1b14 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Mon, 31 Jul 2023 09:57:00 +0200 Subject: [PATCH 7/7] Better wording --- src/includes/platforms/configuration/integrations/default.mdx | 2 +- .../common/configuration/integrations/default-integrations.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/includes/platforms/configuration/integrations/default.mdx b/src/includes/platforms/configuration/integrations/default.mdx index 3047d0897d82f3..197cc34438d2df 100644 --- a/src/includes/platforms/configuration/integrations/default.mdx +++ b/src/includes/platforms/configuration/integrations/default.mdx @@ -91,7 +91,7 @@ _Import name: `Sentry.Integrations.LinkedErrors`_ 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. +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: diff --git a/src/platforms/node/common/configuration/integrations/default-integrations.mdx b/src/platforms/node/common/configuration/integrations/default-integrations.mdx index 8b424e16448c6b..799adb02e8e50b 100644 --- a/src/platforms/node/common/configuration/integrations/default-integrations.mdx +++ b/src/platforms/node/common/configuration/integrations/default-integrations.mdx @@ -33,7 +33,7 @@ _Import name: `Sentry.Integrations.LinkedErrors`_ 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. +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: