feat(develop-docs): BatchProcessor Process Terminations #15274
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 <rom4ek93@gmail.com>
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
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 <rom4ek93@gmail.com>
<!-- 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.
## DESCRIBE YOUR PR This PR changes the TanStack Start docs to be compatible with the current 1.0 RC version. ## 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 --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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) ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Sarah Mischinger <sarah@codingwriter.com>
…#15316) ## DESCRIBE YOUR PR Related to #15312 Fixed broken links that the 404 linter didn't catch while it was broken. ## On Devloper Docs - 🌐 http://localhost:3000/sdk/telemetry/profiles/continuous-profiling-api - `[Replay session](/product/explore/session-replay/web/)` - 🌐 http://localhost:3000/sdk/telemetry/traces/modules/ai-agents - `[general size limits](/concepts/data-management/size-limits/)` ## On user facing docs - 🌐 http://localhost:3000/security-legal-pii/security/data-retention-periods - `[Uptime](/product/monitoring/)` - `[Attachments](/product/issues/issue-details/attachments/)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/install__v9.x - `[using our Lambda Layer (recommended)](./install/layer__v9.x)` -` [installing the Sentry AWS NPM package](./install/cjs-npm__v9.x)` - `[ESM instructions](./install/esm-npm__v9.x)` - 🌐 http://localhost:3000/platforms/javascript/guides/cloudflare/sourcemaps - `[Cloudflare Workers guide](/platforms/javascript/sourcemaps/uploading/wrangler/)` - 🌐 http://localhost:3000/platforms/javascript/guides/nuxt/sourcemaps - `[source maps options](/platforms/javascript/guides/nuxt/configuration/build/#source-maps-options)` - 🌐 http://localhost:3000/platforms/javascript/guides/solidstart/sourcemaps - `[Manual Configuration](../overview/javascript.solidstart.mdx)` - `[source maps options](/platforms/javascript/guides/solidstart/configuration/build/#source-maps-options)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/install/layer__v9.x - `[manually](../cjs-npm)` - `[ESM guide](../esm-npm)` - 🌐 http://localhost:3000/platforms/javascript/guides/cordova/configuration/options - Obscured CORS docs because it doesn't apply to Cordova - 🌐 http://localhost:3000/platforms/javascript/guides/electron/configuration/options - `[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/configuration/lambda-wrapper - `[initializing the SDK in code](../../install/cjs-layer#alternative-initialize-the-sdk-in-code)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/install/npm__v9.x - `[CommonJS instructions](./cjs-npm__v9.x)` - `[ESM instructions](./esm-npm__v9.x)` - `[CommonJS instructions](./cjs-npm__v9.x)` - `[ESM instructions](./esm-npm__v9.x)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x - `[Lambda Layer](../cjs-layer)` - 🌐 http://localhost:3000/platforms/javascript/guides/electron/configuration/environments - `[Custom IPC Namespace section](/platforms/javascript/guides/electron/platforms/javascript/guides/electron/#custom-ipc-namespace)` - 🌐 http://localhost:3000/platforms/javascript/guides/aws-lambda/configuration/integrations/unhandledrejection - `[manually wrapped](/platforms/javascript/guides/aws-lambda/install/cjs-layer/#alternative-initialize-the-sdk-in-code)` ## 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 --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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) --------- Co-authored-by: Shannon Anahata <shannonanahata@gmail.com> Co-authored-by: Abdellah Hariti <haritiabdellah@gmail.com>
|
Sorry about all the review triggers. Something got messed up when merging master into this branch. |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
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. |
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?
added 2 commits
October 30, 2025 13:49
sfanahata
reviewed
Oct 30, 2025
|
|
||
| When the SDK detects a sudden process termination, it MUST put all remaining items in the BatchProcessor into one envelope and flush it. If your SDK has an offline cache, it MAY flush the envelope to disk and skip sending it to Sentry, if it ensures to send the envelope the next time the SDK starts. The BatchProcessor MUST keep its existing logic described in the [specification](#specification) above. | ||
|
|
||
| Suppose your SDK can't reliably detect sudden process terminations, or it can't reliably flush envelopes to Sentry or disk when a sudden process termination happens. In that case, it SHOULD implement the [FileStream Cache](#2-file-stream-cache) or the [DoubleRotatingBuffer](#3-doublerotatingbuffer). It's acceptable to start with this option as a best effort interim solution before adding one of the more complex options. |
There was a problem hiding this comment.
Suggested change
| Suppose your SDK can't reliably detect sudden process terminations, or it can't reliably flush envelopes to Sentry or disk when a sudden process termination happens. In that case, it SHOULD implement the [FileStream Cache](#2-file-stream-cache) or the [DoubleRotatingBuffer](#3-doublerotatingbuffer). It's acceptable to start with this option as a best effort interim solution before adding one of the more complex options. | |
| Suppose your SDK can't reliably detect sudden process terminations, or it can't reliably flush envelopes to Sentry or disk when a sudden process termination happens. In that case, it SHOULD implement the [FileStream Cache](#2-filestream-cache) or the [DoubleRotatingBuffer](#3-doublerotatingbuffer). It's acceptable to start with this option as a best effort interim solution before adding one of the more complex options. |
sfanahata
reviewed
Oct 30, 2025
|
|
||
| ### 3. DoubleRotatingBuffer | ||
|
|
||
| SDKs should only consider implementing this option when options [1](#1-flush-all-data) or [2](#2-file-stream-cache) are insufficient to prevent data loss within their ecosystem. We recommend this option only if SDKs are unable to reliably detect sudden process terminations or consistently store envelopes to disk during such terminations. |
There was a problem hiding this comment.
Suggested change
| SDKs should only consider implementing this option when options [1](#1-flush-all-data) or [2](#2-file-stream-cache) are insufficient to prevent data loss within their ecosystem. We recommend this option only if SDKs are unable to reliably detect sudden process terminations or consistently store envelopes to disk during such terminations. | |
| SDKs should only consider implementing this option when options [1](#1-flush-all-data) or [2](#2-filestream-cache) are insufficient to prevent data loss within their ecosystem. We recommend this option only if SDKs are unable to reliably detect sudden process terminations or consistently store envelopes to disk during such terminations. |
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: