feat(develop-docs): TelemetryBuffer Process Terminations #15274
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
romtsn
reviewed
Oct 28, 2025
romtsn
reviewed
Oct 28, 2025
romtsn
reviewed
Oct 28, 2025
romtsn
reviewed
Oct 28, 2025
Co-authored-by: Roman Zavarnitsyn <[email protected]>
Co-authored-by: Roman Zavarnitsyn <[email protected]>
Co-authored-by: Roman Zavarnitsyn <[email protected]>
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
romtsn
reviewed
Oct 29, 2025
Co-authored-by: Roman Zavarnitsyn <[email protected]>
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR - Add a new option `screenshotStrategy` which has been introduced in this [PR](getsentry/sentry-java#4777) and allows customers to specify a more reliable masking strategy. ## 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.): <!-- ENTER DATE HERE --> - [x] Other deadline: Ideally next week - [ ] None: Not urgent, can wait up to 1 week+
…#15336) <!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR We changed the default behavior of the integration in the latest Python SDK release. ## 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.): <!-- ENTER DATE HERE --> - [x] Other deadline: ASAP as we just released this - [ ] 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](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
This PR adds a new product page for drains, and adds a page for vercel log drains as well. Vercel drains are marked as closed alpha for now, but will be promoted to EA this week.
7 tasks
|
|
||
| The BatchProcessor uses two buffers to minimize data loss in the event of an abnormal process termination: | ||
| * **Crash-Safe List**: A list stored in a crash-safe space to prevent data loss during detectable abnormal process terminations. | ||
| * **Async IO Cache**: When a process terminates without the SDK being able to detect it, the crash-safe list loses all its elements. Therefore, the BatchProcessor uses a second buffer, the async IO cache, that stores elements to disk on a background thread to avoid blocking the calling thread, which ensures minimal data loss when such terminations occur. |
Member
There was a problem hiding this comment.
It's not very clear to me.
If the list is called "crash-safe list", i assume it doesn't lose elements on crash.
Is the crash-safe list kept in memory, while the async IO cache is written to file?
Member
Author
There was a problem hiding this comment.
Yes, it doesn't lose elements when the SDK can detect the abnormal process termination.
Is the crash-safe list kept in memory, while the async IO cache is written to file?
Yes exactly. What would help you to make that clearer?
added 2 commits
October 30, 2025 13:49
sfanahata
reviewed
Oct 30, 2025
sfanahata
reviewed
Oct 30, 2025
cleptric
requested changes
Nov 3, 2025
Member
cleptric
left a comment
cleptric
left a comment
There was a problem hiding this comment.
This is not a good place to document these changes. For one, this page is clearly marked as WIP, and applies to spans only.
Secondly, we have this exact work currently underway by @giortzisg, so I would kindly ask that both of these work streams are merged.
Additonally, this seems to be mostly about mobile, which is fine to be handled differently, but should be also documented accordingly.
Co-authored-by: Shannon Anahata <[email protected]>
Co-authored-by: Shannon Anahata <[email protected]>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
develop-docs/sdk/telemetry/telemetry-buffer/browser-telemetry-buffer.mdx
Outdated
Show resolved
Hide resolved
Member
Author
|
Blocked by #15411. |
Member
Author
|
@cleptric, please double check if you are OK with the current structure and place of the spec as you pointed out here #15274 (review). If yes, please approve to unblock this PR. |
philipphofmann
changed the title
cleptric
approved these changes
Nov 13, 2025
philipphofmann
deleted the
feat/batch-processor-abnormal-terminations
branch
denrase
reviewed
Nov 13, 2025
|
|
||
| The BatchProcessor MUST forward all items to the transport after the SDK when containing spans or logs exceeding 1MiB in size. The SDK MAY choose a different value for the max batch size keeping the [envelope max sizes](/sdk/data-model/envelopes/#size-limits) in mind. The SDK MUST calculate the size of a span or a log to manage the BatchProcessor's memory footprint. The SDK MUST serialize the span or log and calculate the size based on the serialized JSON bytes. As serialization is expensive, the BatchProcessor SHOULD keep track of the serialized spans and logs and pass these to the envelope to avoid serializing multiple times. | ||
|
|
||
| When the BatchProcessor forwards all spans or logs to the transport, it MUST reset its timeout and remove all spans and logs. The SDK MUST apply filtering and sampling before adding spans or logs to the BatchProcessor. The SDK MUST apply rate limits to spans and logs after they leave the BatchProcessor to send as much data as possible by dropping data as late as possible. |
Collaborator
There was a problem hiding this comment.
@philipphofmann Replay is imposing a 1000 log item limit, and SDKs should to send max 100 in and envelope. We should probably also mention this here somewhere. If we only limit size and time without count, envelopes can be dropped by replay.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
This PR migrates the logs for crashes RFC to the BatchProcessor.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: