-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
ref(native): Update various parts of docs, adding 'Store Minidumps As Attachments' section #12398
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
Changes from all commits
b15824b
3173ba2
20eddc3
6f72357
771cbb7
4d366d5
a46b8fc
fa26cac
f4eaf5f
e9533e6
923438a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: "Store Minidumps As Attachments" | ||
| description: "Learn how to enable storing minidumps as attachments in issue details." | ||
| sidebar_order: 90 | ||
| --- | ||
|
|
||
|
|
||
| <Include name="store-minidumps-as-attachments-intro" /> | ||
| <Include name="store-minidumps-as-attachments-configuration" /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: "Store Minidumps As Attachments" | ||
| description: "Learn how to enable storing minidumps as attachments in issue details." | ||
| sidebar_order: 90 | ||
| --- | ||
|
|
||
| <Include name="store-minidumps-as-attachments-intro" /> | ||
|
|
||
| <Alert level="note">☝ This feature is supported on Windows, Linux, and Android.</Alert> | ||
|
|
||
| <Include name="store-minidumps-as-attachments-configuration" /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| --- | ||
|
|
||
|
|
||
| <Include name="store-minidumps-as-attachments-intro" /> | ||
|
|
||
| <Alert level="note">☝ This feature is supported on Windows, Linux, and Android.</Alert> | ||
|
|
||
| <Include name="store-minidumps-as-attachments-configuration" /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this weird formatting was probably my editor? it is annoying
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you have prettier enabled it might just be formatting on save, getting rid of these extra trailing spaces. |
||
|
|
||
| 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 <PlatformLink to= | |
| </Note> | ||
|
|
||
| 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 | ||
|
|
||
| <Include name="store-minidumps-as-attachments-intro" /> | ||
|
|
||
| <Alert level="note">☝ This feature is supported on Windows, Linux, and Android.</Alert> | ||
|
|
||
| <Include name="store-minidumps-as-attachments-configuration" /> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|  |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
|
|
||
| <Include name="common-imgs/store-minidumps-as-attachments" /> | ||
|
|
||
| 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. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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. | ||||||
Uh oh!
There was an error while loading. Please reload this page.