[skill-drift] update(sentry-nestjs-sdk): document experimentalUseDiagnosticsChannelInjection() - #292
Open
github-actions[bot] wants to merge 1 commit into
Conversation
…nosticsChannelInjection() Automated drift-fix run. Co-Authored-By: Claude (claude-sonnet-5) <noreply@anthropic.com>
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
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.
Warning
Auto-generated from external SDK content. Review all links and code suggestions before acting on them.
@sentry/nestjs10.66.0 (released as part of 10.67.0) ships a new experimental public API,Sentry.experimentalUseDiagnosticsChannelInjection(), that opts a NestJS app into a diagnostics-channel-based ("orchestrion") instrumentation path instead of the default OpenTelemetry-basednestIntegration. It must be called beforeSentry.init(). Verified by reading the released source at tag10.67.0:packages/nestjs/src/integrations/nest.ts—nestIntegrationpicks betweensubscribeToNestChannels()(orchestrion path) andinstrumentNest()(OTel path) based onisOrchestrionInjected().packages/node/src/sdk/experimentalUseDiagnosticsChannelInjection.ts— the opt-in function and its JSDoc, re-exported into@sentry/nestjsviaexport * from '@sentry/node'.dev-packages/e2e-tests/test-applications/nestjs-orchestrionconfirms the orchestrion path produces the same span tree as the OTel path (only the spanoriginattribute changes, e.g.auto.http.otel.nestjs->auto.http.orchestrion.nestjs), and needs no bundler plugin for plain Node apps.This was completely undocumented in
src/references/sdks/nestjs/(grepped for "orchestrion", zero hits before this change).Changes made:
tracing.md: added an "Experimental: orchestrion (diagnostics-channel) instrumentation" subsection under Architecture, with the opt-in code snippet and a note that it's experimental/not a default recommendation.index.md: added a Version Requirements row forexperimentalUseDiagnosticsChannelInjection()(10.66.0).Other PRs reviewed but not actioned (both merged/released, non-user-facing):
ref(nestjs): extract shared span helpers— pure internal refactor (extractswrap-handlers.ts/wrap-route.ts/wrap-components.tsshared between the OTel and orchestrion code paths), no public API or behavior change.ref: Omit redundant captureError: false from tracing-channel callsites— internal cleanup touchingorchestrion-subscriber.ts, no public surface change.Source PRs
captureError: falsefrom tracing-channel callsites