feat(opentelemetry): create otel instrumentation for typed-express-router #1044
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
starfy84
force-pushed
the
DX-1473-create-otel-wrapper-for-typed-express-router
branch
2 times, most recently
from
9c177cd to
0bff27e
Compare
ericcrosson-bitgo
requested changes
Jun 27, 2025
packages/opentelemetry-instrumentation-typed-express-router/test/instrumentation.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation-typed-express-router/test/instrumentation.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation-typed-express-router/src/version.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation-typed-express-router/src/utils.ts
Outdated
Show resolved
Hide resolved
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
starfy84
force-pushed
the
DX-1473-create-otel-wrapper-for-typed-express-router
branch
from
43daf20 to
3781856
Compare
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-express/test/fixtures/use-express.mjs
Fixed
Show fixed
Hide fixed
packages/opentelemetry-instrumentation-typed-express-router/src/instrumentation.ts
Fixed
Show fixed
Hide fixed
starfy84
force-pushed
the
DX-1473-create-otel-wrapper-for-typed-express-router
branch
4 times, most recently
from
6cd264b to
11fc7f0
Compare
starfy84
commented
Jul 9, 2025
| @@ -20,6 +29,8 @@ import { | |||
| WrappedRouterOptions, | |||
| } from './types'; | |||
|
|
|||
| import type { Span } from '@opentelemetry/api'; | |||
There was a problem hiding this comment.
Not sure if this is allowed. What happens when @opentelemetry/api isn't installed?
| } | ||
| }; | ||
| next(); | ||
| }; | ||
|
|
||
| const endDecodeSpanMiddleware: UncheckedRequestHandler = (req, _, next) => { |
There was a problem hiding this comment.
This middleware ends the decode span.
My only concern with this is that we're adding middleware to "check" (mainly just record, we don't throw/send any error status codes) for validation errors even though makeAddUncheckedRoute implies that the validation shouldn't be checked.
| import type { Attributes, Span, Tracer } from '@opentelemetry/api'; | ||
| import * as PathReporter from 'io-ts/lib/PathReporter'; | ||
|
|
||
| let otelApi: any; |
There was a problem hiding this comment.
Are we able to give this a concrete type definition? I wasn't able to figure out a way
|
|
||
| import { Errors } from 'io-ts'; | ||
| import type { SpanMetadata } from './types'; | ||
| import type { Attributes, Span, Tracer } from '@opentelemetry/api'; |
There was a problem hiding this comment.
Same concern here as the type imports in index.ts
Comment on lines
443
to
447
| if (require.cache[resolvedPath]) { | ||
| require.cache[resolvedPath] = { | ||
| ...require.cache[resolvedPath], | ||
| exports: undefined, | ||
| }; | ||
| } | ||
| delete require.cache[require.resolve('../src/telemetry')]; |
There was a problem hiding this comment.
Hack to pretend that package is not available
typed-express-router
starfy84
force-pushed
the
DX-1473-create-otel-wrapper-for-typed-express-router
branch
from
f804fb4 to
0158ca3
Compare
Back to you, @starfy84! Co-authored-by: Dereck Tu <[email protected]>
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.
Ticket: DX-1473
This PR implements a manual opentelemetry instrumentation for @api-ts/typed-express-router.
It modifies the library's
wrapRouterandcreateRouterfunctions to create encode and decode spans.For the telemetry to work, @opentelemetry/api needs to be installed