diff --git a/docs/platforms/native/common/data-management/store-minidumps-as-attachments/index.mdx b/docs/platforms/native/common/data-management/store-minidumps-as-attachments/index.mdx new file mode 100644 index 0000000000000..334609ded3d4b --- /dev/null +++ b/docs/platforms/native/common/data-management/store-minidumps-as-attachments/index.mdx @@ -0,0 +1,9 @@ +--- +title: "Store Minidumps As Attachments" +description: "Learn how to enable storing minidumps as attachments in issue details." +sidebar_order: 90 +--- + + + + diff --git a/docs/platforms/native/common/enriching-events/attachments/img/slide-bar-native-crashes.png b/docs/platforms/native/common/enriching-events/attachments/img/slide-bar-native-crashes.png deleted file mode 100644 index 95f3d6fb49811..0000000000000 Binary files a/docs/platforms/native/common/enriching-events/attachments/img/slide-bar-native-crashes.png and /dev/null differ diff --git a/docs/platforms/native/common/enriching-events/attachments/index.mdx b/docs/platforms/native/common/enriching-events/attachments/index.mdx index c6598abf220bb..82f84faf101e9 100644 --- a/docs/platforms/native/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/native/common/enriching-events/attachments/index.mdx @@ -29,20 +29,6 @@ Attachments persist for 30 days; if your total storage included in your quota is Learn more about how attachments impact your [quota](/pricing/quotas/). -## Crash Reports and Privacy - -Crash reports may contain sensitive information about the target system, such as environment variables, local pathnames, or in-memory representations of input fields, including passwords. By default, Sentry only uses crash report files to create events and immediately drops them. All sensitive information is stripped from the resulting events. - -All other types of attachments, such as log files or screenshots, are stored for 30 days when sent to Sentry. Note that Sentry does not apply data scrubbing to attachments. - -### Enabling Crash Report Storage - -You can enable _Store Native Crash Reports_ in your organization's **Security and Privacy Settings**. By default, this setting is disabled. Determine the maximum number of crash reports that will be stored per issue; disabled, unlimited, or maximum per issue: - -![Attachments Example](./img/slide-bar-native-crashes.png) - -If you set a limit per issue, as in the example above, a limit of 10, Sentry will store the first 10 attachments associated with this issue, but drop any that follow. To make room for additional attachments, delete them. Sentry will then accept attachments until the limit is reached again. - ### Access to Attachments To limit access to attachments, navigate to your organization's **General Settings**, then select the _Attachments Access_ dropdown to set appropriate access — any member of your organization, the organization billing owner, member, admin, manager, or owner. @@ -51,6 +37,14 @@ To limit access to attachments, navigate to your organization's **General Settin By default, access is granted to all members when storage is enabled. If a member does not have access to the project, the ability to download an attachment is not available; the button will be greyed out in Sentry. The member may only view that an attachment is stored. +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + + ## Viewing Attachments Attachments display on the bottom of the **Issue Details** page for the event that is shown. diff --git a/docs/platforms/native/guides/minidumps/index.mdx b/docs/platforms/native/guides/minidumps/index.mdx index 84a477ae45253..4e4871be2313b 100644 --- a/docs/platforms/native/guides/minidumps/index.mdx +++ b/docs/platforms/native/guides/minidumps/index.mdx @@ -123,3 +123,8 @@ uploads. These limits are subject to future change and defined currently as: - _100MB_ for all files combined - _100MB_ for each file individually - _1MB_ for event payloads + +## Store Minidumps as Attachments + + + diff --git a/docs/platforms/unity/data-management/store-minidumps-as-attachments/index.mdx b/docs/platforms/unity/data-management/store-minidumps-as-attachments/index.mdx new file mode 100644 index 0000000000000..b821cb4a47ffd --- /dev/null +++ b/docs/platforms/unity/data-management/store-minidumps-as-attachments/index.mdx @@ -0,0 +1,11 @@ +--- +title: "Store Minidumps As Attachments" +description: "Learn how to enable storing minidumps as attachments in issue details." +sidebar_order: 90 +--- + + + +☝ This feature is supported on Windows, Linux, and Android. + + diff --git a/docs/platforms/unity/enriching-events/attachments/index.mdx b/docs/platforms/unity/enriching-events/attachments/index.mdx index 9fc8f0a985f49..343bb29c1d3aa 100644 --- a/docs/platforms/unity/enriching-events/attachments/index.mdx +++ b/docs/platforms/unity/enriching-events/attachments/index.mdx @@ -71,6 +71,14 @@ To limit access to attachments, navigate to your organization's **General Settin By default, access is granted to all members when storage is enabled. If a member does not have access to the project, the ability to download an attachment is not available; the button will be greyed out in Sentry. The member may only view that an attachment is stored. +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + + ## Viewing Attachments Attachments display on the bottom of the **Issue Details** page for the event that is shown. diff --git a/docs/platforms/unity/native-support/index.mdx b/docs/platforms/unity/native-support/index.mdx index e42f6a7d67367..18afc60a5a610 100644 --- a/docs/platforms/unity/native-support/index.mdx +++ b/docs/platforms/unity/native-support/index.mdx @@ -74,3 +74,11 @@ If you don't want to rely on the automated symbol upload, you can run `sentry-cl ```bash sentry-cli --auth-token ___ORG_AUTH_TOKEN___ debug-files upload --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS ``` + +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx index a974c9912e91b..54a535b99a8e6 100644 --- a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx +++ b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx @@ -174,3 +174,11 @@ are subject to future change and defined currently as: ## Issues With the Crash Reporter Check out this community-generated [thread in Sentry's forum](https://forum.sentry.io/t/unreal-engine-crash-reporter-cant-get-it-to-work/7643) for UE Crash Reporter troubleshooting tips and solutions. + +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + diff --git a/docs/platforms/unreal/data-management/store-minidumps-as-attachments/index.mdx b/docs/platforms/unreal/data-management/store-minidumps-as-attachments/index.mdx new file mode 100644 index 0000000000000..6f1275c4c8414 --- /dev/null +++ b/docs/platforms/unreal/data-management/store-minidumps-as-attachments/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Store Minidumps As Attachments" +description: "Learn about to store minidumps as attachments for improved processing and download in issue details." +sidebar_order: 90 +--- + + + + +☝ This feature is supported on Windows, Linux, and Android. + + diff --git a/docs/platforms/unreal/enriching-events/attachments/index.mdx b/docs/platforms/unreal/enriching-events/attachments/index.mdx index 48c7fb6734db6..45e64049a54c6 100644 --- a/docs/platforms/unreal/enriching-events/attachments/index.mdx +++ b/docs/platforms/unreal/enriching-events/attachments/index.mdx @@ -112,6 +112,14 @@ To limit access to attachments, navigate to your organization's **General Settin By default, access is granted to all members when storage is enabled. If a member does not have access to the project, the ability to download an attachment is not available; the button will be greyed out in Sentry. The member may only view that an attachment is stored. +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + + ## Viewing Attachments Attachments display on the bottom of the **Issue Details** page for the event that is shown. diff --git a/docs/platforms/unreal/index.mdx b/docs/platforms/unreal/index.mdx index f7b5c066f3ee4..0a9546f0c3a07 100644 --- a/docs/platforms/unreal/index.mdx +++ b/docs/platforms/unreal/index.mdx @@ -34,7 +34,7 @@ Don't already have an account and Sentry project established? Head over to [sent ## Install -Sentry captures data by using an SDK within your application’s runtime. +Sentry captures data by using an SDK within your application’s runtime. The Unreal Engine (UE) SDK is officially supported for the three latest UE versions. However, it is likely to be compatible with older engine versions as well depending on the specific features and functionality that you need. @@ -57,9 +57,9 @@ The table below highlights some key differences between different versions of th | `on_crash` hook (Windows) | Supported | Not supported | Supported | | Sentry CLI ** | Included | Manual download | Included | -Legend: -`*`: Recommended version of the SDK -`**`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion. +Legend: +`*`: Recommended version of the SDK +`**`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion. ### Installing from GitHub Releases (Recommended) @@ -163,3 +163,11 @@ Learn more about manually capturing an error or message in our To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. + +## Store Minidumps as Attachments + + + +☝ This feature is supported on Windows, Linux, and Android. + + diff --git a/includes/common-imgs/img/store-minidumps-as-attachments.png b/includes/common-imgs/img/store-minidumps-as-attachments.png new file mode 100644 index 0000000000000..db3dc13ad9884 Binary files /dev/null and b/includes/common-imgs/img/store-minidumps-as-attachments.png differ diff --git a/includes/common-imgs/store-minidumps-as-attachments.md b/includes/common-imgs/store-minidumps-as-attachments.md new file mode 100644 index 0000000000000..dc73f2fba0da7 --- /dev/null +++ b/includes/common-imgs/store-minidumps-as-attachments.md @@ -0,0 +1 @@ +![Store Minidumps as Attachments Configuration Example](./img/store-minidumps-as-attachments.png) diff --git a/includes/store-minidumps-as-attachments-configuration.mdx b/includes/store-minidumps-as-attachments-configuration.mdx new file mode 100644 index 0000000000000..174822b9b5919 --- /dev/null +++ b/includes/store-minidumps-as-attachments-configuration.mdx @@ -0,0 +1,7 @@ +### Enabling Minidump Storage + +You can enable _Store Minidumps As Attachments_ in your organization or project settings under **Security & Privacy**. By default, this setting is disabled. Determine the maximum number of crash reports that will be stored per issue; disabled, unlimited, or maximum per issue: + + + +If you set a limit per issue, as in the example above, a limit of 5, Sentry will store the first 5 attachments associated with this issue, but drop any that follow. To make room for additional attachments, delete them. Sentry will then accept attachments until the limit is reached again. diff --git a/includes/store-minidumps-as-attachments-intro.mdx b/includes/store-minidumps-as-attachments-intro.mdx new file mode 100644 index 0000000000000..bb192b35f59b0 --- /dev/null +++ b/includes/store-minidumps-as-attachments-intro.mdx @@ -0,0 +1,3 @@ +Minidumps may contain sensitive information about the target system, such as environment variables, local pathnames, or in-memory representations of input fields, including passwords. By default, Sentry only uses minidump files to create events and immediately drops them. All sensitive information is stripped from the resulting events. + +All other types of attachments, such as log files or screenshots, are stored for 30 days when sent to Sentry. Note that Sentry does not apply data scrubbing to attachments.