Skip to content

Commit 10367e7

Browse files
authored
ref: Bump and document attachment size limits (#1913)
Size limits for attachments are now at 100MB. Additionally, this PR adds more information on size limits to the Native SDK and Attachments page.
1 parent 5a12151 commit 10367e7

File tree

6 files changed

+40
-8
lines changed

6 files changed

+40
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Note: This is running both the Jekyll (port 9001) and Gatsby (port 9002) servers
3636

3737
## The Great Gatsby Migration
3838

39-
The repository currently contains a Jekyll site (`./`) as well as a Gatsby site (`./gatsby`). This is to aid with a progressive migratiopn over to Gatsby. There's a bit of magic that you need to understand in how this is deployed:
39+
The repository currently contains a Jekyll site (`./`) as well as a Gatsby site (`./gatsby`). This is to aid with a progressive migration over to Gatsby. There's a bit of magic that you need to understand in how this is deployed:
4040

4141
- **Sidebar:** Jekyll and Gatsby _both_ control the sidebar. If you add a new page in Gatsby at the top level (aka `/docs/parent/THISLEVEL.md`) you will also need to add an empty page in Jekyll at the same location with the `title`, `sidebar_order`, and `gatsby` frontmatter elements:
4242

gatsby/src/docs/accounts/quotas/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In addition, depending on your project’s configuration and the plan you subscr
5555
After these checks are processed, the event counts toward your quota. It is accepted into Sentry, where it persists and is stored.
5656

5757
<Alert>
58-
If the event exceeds 200KB compressed or 1MB decompressed for events and 20MB compressed or 50 MB decompressed for minidump uploads (all files combined), the event will be rejected.
58+
If the event exceeds 200KB compressed or 1MB decompressed for events and 20MB compressed or 100MB decompressed for minidump uploads (all files combined), the event will be rejected.
5959
</Alert>
6060

6161
## What Counts Toward my Quota, Table View

gatsby/src/docs/enriching-error-data/attachments/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Besides crash reports, Sentry can optionally store additional files uploaded in
1313

1414
To receive symbolicated stack traces, you have to upload debug information to Sentry. Unless the option to store crash reports is enabled, Sentry will use the crash reports only to create the event, then will drop the files. For more information, see [Debug Information Files](/workflow/debug-files/).
1515

16+
## Size Limits
17+
18+
Sentry allows at most 100MB of attachments per event, including the crash report file. Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options.
19+
20+
Usually, native crash reports range from a few kilobytes to a few megabytes. This leaves sufficient space to add custom attachments. In case your application generates particularly large crash reports, consider to limit or avoid adding additional attachments in the SDK.
21+
1622
## Storage and Quota Impact
1723

1824
Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored.

src/collections/_documentation/platforms/native/index.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,32 @@ sentry_value_t event = sentry_value_new_message_event(
178178
);
179179
```
180180

181+
### Application Crashes
182+
183+
By default, the Native SDK intercepts crash signals and unhandled exceptions to
184+
send crash reports to Sentry. Depending on the [backend](#integrations), the
185+
crash report can be sent as a conventional event or as a native crash report
186+
file. On Windows, Linux, and macOS, the default backends send binary Minidump
187+
files. Sentry processes them to extract stack traces and exception information
188+
into a readable crash report.
189+
190+
For more information on Minidumps and the limits that apply, see
191+
[What is a Minidump](/platforms/native/minidumps#what-is-a-minidump).
192+
193+
{% capture __alert_content -%}
194+
The size of Minidumps can vary between a few kilobytes and many megabytes.
195+
Contributing factors are the number of threads, size of stack space, and the
196+
number of heap memory regions referenced from the stack. As Minidumps often
197+
contain large regions of empty memory, the SDK compresses Minidumps before
198+
uploading. Sentry drops requests with a body larger than _20MB_, or if they
199+
contain files larger than _100MB_.
200+
{%- endcapture -%}
201+
{%- include components/alert.html
202+
title="Size Limits"
203+
content=__alert_content
204+
level="warning"
205+
%}
206+
181207
## Uploading Debug Information
182208

183209
{% include platforms/upload-debug-info.md %}
@@ -364,7 +390,7 @@ For more information, see:
364390
Filters](https://blog.sentry.io/2017/11/27/setting-up-inbound-filters).
365391
366392
{% capture __alert_content -%}
367-
The Crashpad Backend sends minidumps with an additional event payload
393+
The Crashpad Backend sends Minidumps with an additional event payload
368394
out-of-process. `before_send` hooks are not invoked when capturing crashes
369395
using Crashpad.
370396
{%- endcapture -%}
@@ -439,7 +465,7 @@ CMake option, with support for the following options:
439465
[Crashpad](https://chromium.googlesource.com/crashpad/crashpad/+/master/README.md)
440466
is an open-source multiplatform crash reporting system written in C++ by Google.
441467
It supports macOS, Windows, and Linux, and features an uploader to
442-
submit minidumps to a configured URL right when the process crashes.
468+
submit Minidumps to a configured URL right when the process crashes.
443469

444470
To use the Crashpad backend with the Native SDK, configure the CMake build
445471
with the `SENTRY_BACKEND=crashpad` option. This will automatically create a

src/collections/_documentation/platforms/native/minidump.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Event ingestion imposes limits on the size and number of fields in multipart
139139
uploads. These limits are subject to future change and defined currently as:
140140

141141
- *20MB* for a compressed minidump request
142-
- *50MB* for the full body after decompression
143-
- *50MB* for all files combined
144-
- *50MB* for each file individually
142+
- *100MB* for the full body after decompression
143+
- *100MB* for all files combined
144+
- *100MB* for each file individually
145145
- *1MB* for event payloads

src/collections/_documentation/platforms/native/ue4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ Event ingestion imposes limits on the size of UE4 crash reports. These limits
9595
are subject to future change and defined currently as:
9696

9797
- *20MB* for a compressed request
98-
- *50MB* for the full crash report after decompression
98+
- *100MB* for the full crash report after decompression

0 commit comments

Comments
 (0)