feat(remix): Add orchestrion-based remix instrumentation#22244
Open
mydea wants to merge 9 commits into
Open
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
size-limit report 📦
|
mydea
force-pushed
the
francesconovy/js-2483-rewrite-remixinstrumentation-to-orchestrion
branch
from
41d5562 to
24c9db3
Compare
`instrumentRemix` only subscribed to `callRouteAction` when `actionFormDataAttributes` was configured, so ACTION spans were never created unless form-data capture was opted into. The OTel instrumentation always patched `callRouteAction` and used those keys only for optional attribute extraction. Always subscribe; the request clone + async form-data read now happen only when capture is configured. Adds a regression test (separate file so the channel subscribes with no form-data config) asserting ACTION spans are still created. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The OpenTelemetry branch of `remixIntegration` passed the form-data key map
straight into `instrumentRemixWithOpenTelemetry`, which expects
`{ actionFormDataAttributes: ... }`. As a result the map was treated as the
whole instrumentation config, so `RemixInstrumentation`'s default
`{ _action: 'actionType' }` mapping stayed in place — applying even when capture
wasn't configured, and ignoring the opted-in keys when it was.
Wrap the map in the options object. Adds a test for the OTel branch asserting the
call shape (both opted-in and not).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The build-injection guard only asserted the `requestHandler` and `callRouteLoader` publishers, but the transform config also injects `matchServerRoutes` and `callRouteAction`. A silent failure to inject either of those would have slipped past the guard, whose whole purpose is to prove build-time injection. Assert all four channels. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mydea
force-pushed
the
francesconovy/js-2483-rewrite-remixinstrumentation-to-orchestrion
branch
from
929eaf5 to
e524832
Compare
`deferSpanEnd` read the form data only at `asyncEnd`, after `callRouteAction` had already returned. A channel can't delay the action promise the way the vendored instrumentation did, so the parent `requestHandler` span could finish and flush the transaction before the form-data attributes were applied and the ACTION span ended, dropping that data. Start the form-data read at span start (from a clone taken before the action consumes the body) so it overlaps the action's execution. By `asyncEnd` the read is virtually always resolved, so applying the attributes and ending the span costs a single microtask - comfortably inside the response-rendering gap before the parent span ends. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mydea
changed the title
RemixInstrumentation to orchestrion
mydea
requested review from
chargome,
nicohrubec and
s1gr1d
and removed request for
a team
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 7957bd3. Configure here.
| // Additional things that need to be bundled but are not covered by the above | ||
| // Remix needs to bundle this so @remix-run/server-runtime is _also_ bundled | ||
| '@remix-run/node', | ||
| ]; |
There was a problem hiding this comment.
Global Remix force-bundle leak
Low Severity
instrumentedModuleNames always appends @remix-run/node for every orchestrion consumer, not only Remix apps. That helper feeds Vite ssr.noExternal and webpack/esbuild external stripping globally, so a Remix-specific bundling requirement leaks into Nest, Express, and other SDK setups.
Reviewed by Cursor Bugbot for commit 7957bd3. Configure here.
Member
Author
There was a problem hiding this comment.
this is fine, same with all others, if this is not found it will simply be ignored
s1gr1d
reviewed
Jul 15, 2026
Comment on lines
+22
to
+23
| const MATCH_ROUTE_ID = 'match.route.id'; | ||
| const MATCH_PARAMS = 'match.params'; |
Member
There was a problem hiding this comment.
Those attributes should probably also be added to sentry conventions (as deprecated) as we can use http.route and our url.path.parameter.<key instead.
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| ...uniq([...SENTRY_INSTRUMENTATIONS, ...instrumentations].map(i => i.module.name)), | ||
| // Additional things that need to be bundled but are not covered by the above | ||
| // Remix needs to bundle this so @remix-run/server-runtime is _also_ bundled | ||
| '@remix-run/node', |
Contributor
There was a problem hiding this comment.
Bug: The instrumentedModuleNames function unconditionally adds @remix-run/node to the bundle list, causing build failures for any non-Remix project using orchestrion.
Severity: CRITICAL
Suggested Fix
Conditionally add '@remix-run/node' to the list returned by instrumentedModuleNames only when the configuration indicates that the project is using Remix instrumentation. This will prevent the module from being added to the bundle list for non-Remix projects.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: packages/server-utils/src/orchestrion/config/index.ts#L91
Potential issue: The `instrumentedModuleNames` function unconditionally adds
`'@remix-run/node'` to a list of modules that are force-bundled by Vite via the
`ssr.noExternal` option. This function is used for all projects that enable orchestrion,
not just Remix projects. For non-Remix projects (e.g., SvelteKit, Astro) that use
orchestrion, the `@remix-run/node` package is not a dependency. As a result, the Vite
build process will fail with a module resolution error when it attempts to find and
bundle this non-existent package, breaking the build for all non-Remix orchestrion
users.
Did we get this right? 👍 / 👎 to inform future reviews.
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
2 participants
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.
Rewrites the vendored
RemixInstrumentation(an OpenTelemetryInstrumentationBasethat patched@remix-run/server-runtime) to a diagnostics-channel listener, with orchestrion injecting the channels into the instrumented module at build time.SDK changes
@sentry/server-utils— populated the orchestrion config for@remix-run/server-runtime(orchestrion/config/remix.ts)@sentry/remix— adjusted theremixIntegrationso it runs either OTEL-based instrumentation, or prchestrion-based instrumentation if opted in.E2E changes
remix-orchestriontest app intocreate-remix-app-v2as anINJECT_ORCHESTRION-gatedsentryTestvariant, so one codebase runs both the OpenTelemetry and orchestrion paths (build-time injection via the orchestrion Vite plugin, DB routes + docker for mysql/ioredis, and a build-injection assertion). The base transaction tests run in both variants as a parity check.@remix-run/server-runtimereachable by the build-time transform,@remix-run/nodeis force-bundled (it re-exports server-runtime, which otherwise stays external and is loaded byremix-serveat runtime, outside the Vite bundle).Fixes #20910