Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
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" />
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

<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" />

## Viewing Attachments

Attachments display on the bottom of the **Issue Details** page for the event that is shown.
Expand Down
5 changes: 5 additions & 0 deletions docs/platforms/native/guides/minidumps/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<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" />
8 changes: 8 additions & 0 deletions docs/platforms/unity/enriching-events/attachments/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<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" />

## Viewing Attachments

Attachments display on the bottom of the **Issue Details** page for the event that is shown.
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/unity/native-support/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<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
Expand Up @@ -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

<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" />
8 changes: 8 additions & 0 deletions docs/platforms/unreal/enriching-events/attachments/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<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" />

## Viewing Attachments

Attachments display on the bottom of the **Issue Details** page for the event that is shown.
Expand Down
16 changes: 12 additions & 4 deletions docs/platforms/unreal/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

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

this weird formatting was probably my editor? it is annoying

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Expand All @@ -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)

Expand Down Expand Up @@ -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" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions includes/common-imgs/store-minidumps-as-attachments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
![Store Minidumps as Attachments Configuration Example](./img/store-minidumps-as-attachments.png)
7 changes: 7 additions & 0 deletions includes/store-minidumps-as-attachments-configuration.mdx
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.
3 changes: 3 additions & 0 deletions includes/store-minidumps-as-attachments-intro.mdx
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
[Minidumps](/platforms/native/guides/minidumps/#what-is-a-minidump) 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.
Loading