Skip to content

feat(envelope): Attachment placeholder#16483

Merged
jjbayer merged 5 commits into
masterfrom
feat/attachment-placeholder
Feb 24, 2026
Merged

feat(envelope): Attachment placeholder#16483
jjbayer merged 5 commits into
masterfrom
feat/attachment-placeholder

Conversation

@jjbayer

@jjbayer jjbayer commented Feb 20, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Document attachment placeholders to represent large files that do not fit in a request to the envelope endpoint.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

ref: INGEST-726

@vercel

vercel Bot commented Feb 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 24, 2026 9:16am
sentry-docs Ready Ready Preview, Comment Feb 24, 2026 9:16am

Request Review

Comment on lines +229 to +239
**Workflow:**

1. If an attachment is larger than ~100 MiB, upload it to the [TUS](https://tus.io/protocols/resumable-upload#creation-with-upload)-conformant upload endpoint:
```shell
curl -X POST https://o0.ingest.sentry.io/api/0/upload/ \
--header "Tus-Resumable: 1.0.0" \
--header "Content-Type: application/offset+octet-stream" \
--header "Upload-Length: ${FILE_SIZE}" \
--data @myfile.log
```
2. Upon successful upload, attach a placeholder item to the event envelope, using the `Location` header from the upload response.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'd like to document the upload endpoint on its own page, but I didn't find a good place for it yet.

@jjbayer jjbayer marked this pull request as ready for review February 20, 2026 10:29
@jjbayer jjbayer requested review from a team and jpnurmi February 20, 2026 10:29
@linear

linear Bot commented Feb 20, 2026

Copy link
Copy Markdown

Comment thread develop-docs/sdk/foundations/data-model/envelope-items.mdx Outdated

@Dav1dde Dav1dde left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I assume trace attachments will not make use of this, as they already contain a place to store metadata and link to the location?

@jjbayer

jjbayer commented Feb 20, 2026

Copy link
Copy Markdown
Member Author

I assume trace attachments will not make use of this, as they already contain a place to store metadata and link to the location?

@Dav1dde Unclear, it might make sense to use attachment-ref for trace attachment in the future, but we could also set meta_length == length for trace attachments and use the existing item, like you said.

@jjbayer jjbayer enabled auto-merge (squash) February 24, 2026 09:06
@jjbayer jjbayer merged commit dac71a5 into master Feb 24, 2026
17 checks passed
@jjbayer jjbayer deleted the feat/attachment-placeholder branch February 24, 2026 09:16
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants