Skip to content

feat(telemetry-buffer): Add envelope size limits #15875

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.

Sign up for GitHub

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

Open
philipphofmann wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(telemetry-buffer): Add envelope size limits #15875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 12 additions & 11 deletions develop-docs/sdk/data-model/envelopes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,17 +339,18 @@ SDKs should not rely on Envelope header authentication to retain backward compat
### Size Limits

Event ingestion imposes limits on the size and number of Items in Envelopes.
These limits are subject to future change and defined currently as:

- *40MB* for a compressed envelope request
- *200MB* for a full envelope after decompression
- *200MB* for all attachments combined
- *200MB* for each attachment item
- *1MB* for event (errors and transactions), span, log, and metric (statsd, buckets, meta) items.
- *100KB* for monitor check-in items
- *50MB* for profile items
- *10MB* for compressed replay item
- *100MB* for replay item after decompression
These limits are subject to future change and defined currently as (see [Relay config source](https://github.com/getsentry/relay/blob/master/relay-config/src/config.rs)):

- *200 MiB* for a full envelope after decompression
- *200 MiB* for all attachments combined
- *200 MiB* for each attachment item
- *1 MiB* for event (errors and transactions), span, log, and metric (statsd, buckets, meta) envelope items.
- *2 KiB* average per metric within an envelope. Relay discards the entire envelope if the average of all metrics within it exceeds 2 KiB.
- *100 KiB* for monitor check-in items
- *4 KiB* for client report items
- *50 MiB* for profile items
- *10 MiB* for compressed replay items
- *100 MiB* for replay items after decompression
- *100 sessions* per envelope
- *100 pre-aggregated session buckets* per each `"sessions"` item

Expand Down
4 changes: 4 additions & 0 deletions develop-docs/sdk/telemetry/telemetry-processor/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ The TelemetryBuffer **MUST** forward all data in memory to the transport to avoi
2. When the user calls `SentrySDK.close()`, the TelemetryBuffer **MUST** forward all data in memory to the transport. SDKs **SHOULD** keep their existing closing behavior.
3. When the application shuts down gracefully, the TelemetryBuffer **SHOULD** forward all data in memory to the transport. The transport **SHOULD** keep its existing behavior, which usually stores the data to disk as an envelope. It is not required to call transport `flush`.

## Envelope Size Limits

The different telemetry buffers **MUST** be compatible with the [envelope item size limits](/sdk/data-model/envelopes/#size-limits) imposed by Relay.


## FAQ

Expand Down
Loading