-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(node): Add snippet for OTel setup with NodeSDK #14582
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
Merged
Merged
Changes from all commits
Commits
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
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
78 changes: 78 additions & 0 deletions
78
platform-includes/performance/opentelemetry-setup/javascript.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| To use an existing OpenTelemetry setup, set `skipOpenTelemetrySetup: true` in your `init({})` config, then set up all the components that Sentry needs yourself. Finish by installing `@sentry/opentelemetry` and adding the following: | ||
|
|
||
| ```javascript {tabTitle: NodeTracerProvider} | ||
| const Sentry = require("@sentry/node"); | ||
| const { SentrySpanProcessor, SentryPropagator, SentrySampler } = require("@sentry/opentelemetry"); | ||
|
|
||
| const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node"); | ||
|
|
||
| const sentryClient = Sentry.init({ | ||
| dsn: "___DSN___", | ||
| skipOpenTelemetrySetup: true, | ||
|
|
||
| // The SentrySampler will use this to determine which traces to sample | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
|
|
||
| // Note: This could be BasicTracerProvider or any other provider depending on | ||
| // how you are using the OpenTelemetry SDK | ||
| const provider = new NodeTracerProvider({ | ||
| // Ensure the correct subset of traces is sent to Sentry | ||
| // This also ensures trace propagation works as expected | ||
| sampler: sentryClient ? new SentrySampler(sentryClient) : undefined, | ||
| spanProcessors: [ | ||
| // Ensure spans are correctly linked & sent to Sentry | ||
| new SentrySpanProcessor(), | ||
| // Add additional processors here | ||
| ], | ||
| }); | ||
|
|
||
| provider.register({ | ||
| // Ensure trace propagation works | ||
| // This relies on the SentrySampler for correct propagation | ||
| propagator: new SentryPropagator(), | ||
| // Ensure context & request isolation are correctly managed | ||
| contextManager: new Sentry.SentryContextManager(), | ||
| }); | ||
|
|
||
| // Validate that the setup is correct | ||
| Sentry.validateOpenTelemetrySetup(); | ||
| ``` | ||
|
|
||
| ```javascript {tabTitle: NodeSDK} | ||
| const Sentry = require("@sentry/node"); | ||
| const { SentrySpanProcessor, SentryPropagator, SentrySampler } = require("@sentry/opentelemetry"); | ||
|
|
||
| const { NodeSDK } = require("@opentelemetry/sdk-node") | ||
|
|
||
| const sentryClient = Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| skipOpenTelemetrySetup: true, | ||
|
|
||
| // The SentrySampler will use this to determine which traces to sample | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
|
|
||
| const sdk = new NodeSDK({ | ||
| // Ensure the correct subset of traces is sent to Sentry | ||
| // This also ensures trace propagation works as expected | ||
| sampler: sentryClient ? new SentrySampler(sentryClient) : undefined, | ||
| spanProcessors: [ | ||
| // Ensure spans are correctly linked & sent to Sentry | ||
| new SentrySpanProcessor(), | ||
| // Add additional processors here | ||
| ], | ||
| // Ensure trace propagation works | ||
| // This relies on the SentrySampler for correct propagation | ||
| textMapPropagator: new SentryPropagator(), | ||
| // Ensure context & request isolation are correctly managed | ||
| contextManager: new Sentry.SentryContextManager() | ||
| }); | ||
|
|
||
| sdk.start(); | ||
|
|
||
| // Validate that the setup is correct | ||
| Sentry.validateOpenTelemetrySetup(); | ||
| ``` | ||
|
|
||
| Make sure that all [Required OpenTelemetry Instrumentation](./#required-instrumentation) is set up correctly. Otherwise, the Sentry SDK may not work as expected. | ||
97 changes: 0 additions & 97 deletions
97
platform-includes/performance/opentelemetry-setup/javascript.node.mdx
This file was deleted.
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.
Bug: NodeSDK Configuration Errors
The
NodeSDKconfiguration contains two errors:spanProcessors(plural) instead of the expectedspanProcessor(singular), which prevents Sentry from correctly processing spans.contextManagerproperty, causing a syntax error.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.
spanProcessoris a deprecated option -spanProcessorsshould be used instead.