-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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.
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
feat: Add docs about request isolation in Node SDK #11378
Merged
+59
−0
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0c53967
feat: Add docs about process isolation in Node SDK
mydea 530fe53
adjust wording
mydea c7c6896
adjust example
mydea f870678
Update docs/platforms/javascript/common/enriching-events/process-isol…
mydea 45528a9
Apply suggestions from code review
mydea fce2ca4
rename to request isolation
mydea 41d0ad7
PR feedback
mydea File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
docs/platforms/javascript/common/enriching-events/request-isolation/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Request Isolation | ||
description: "Learn more about how request isolation (or process isolation) works in the Sentry SDK." | ||
supported: | ||
- javascript.nextjs | ||
- javascript.node | ||
- javascript.connect | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.hapi | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.nuxt | ||
- javascript.solidstart | ||
- javascript.sveltekit | ||
- javascript.astro | ||
- javascript.remix | ||
notSupported: | ||
- javascript | ||
--- | ||
|
||
In server-side environments, the <PlatformLink to='/enriching-events/scopes'>isolation scope</PlatformLink> automatically forks around request boundaries. This is done automatically by the SDK. As a result, each request has its own isolation scope, and data set on the isolation scope only applies to events captured during that request. | ||
|
||
However, there are also other times when you may want to have isolation, for example, in background jobs or when you want to isolate a specific part of your code. In these cases, you can use `Sentry.withIsolationScope()` to create a new isolation scope that's valid inside of the callback you pass to it. Learn more about using [withIsolationScope](../scopes/#using-withisolationscope). | ||
|
||
The following example shows how you can use `withIsolationScope` to attach data to a specific job run: | ||
|
||
```javascript | ||
async function job(jobId) { | ||
return Sentry.withIsolationScope(async () => { | ||
// Only valid for events in this callback | ||
Sentry.setTag("jobId", jobId); | ||
await doSomething(); | ||
}); | ||
} | ||
``` |
This file contains 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
13 changes: 13 additions & 0 deletions
13
platform-includes/enriching-events/scopes/with-isolation-scope/javascript.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
```javascript | ||
Sentry.withIsolationScope(function () { | ||
// This user & tag is set inside of this callback | ||
Sentry.setUser({ id: "123" }); | ||
Sentry.setTag("my-tag", "my value"); | ||
|
||
// will be tagged with my-tag="my value" & user | ||
Sentry.captureException(new Error("my error")); | ||
}); | ||
|
||
// will not be tagged with my-tag & user | ||
Sentry.captureException(new Error("my other error")); | ||
``` |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For a person who is not very familiar with Sentry SDK, this sentence is probably too dense for me. I know what request isolation and isolating scopes are but what exactly is "forking a scope". What is the current scope and how it is determined? Why is is meant to be forked less frequently and how is it relevant to me or this conversation? What are those "most cases" where the SDK handles for me. At least what kind of cases are meant to be automatically handled?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we (try to) explain these things in the page above this section (see https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/scopes/). I do agree that all of this is not super easy to understand, feel free to PR changes to wording to this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the thing! I would love to but I 100% don't understand what's going on. The questions I raised in my first comment are questions I don't know the answers to 😅