feat: router instrumentation #458
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## main #458 +/- ##
=======================================
Coverage 95.26% 95.26%
=======================================
Files 140 140
Lines 8399 8399
Branches 815 815
=======================================
Hits 8001 8001
Misses 398 398 |
rauno56
force-pushed
the
feat/router-instrumentation
branch
from
8c5cb3a to
da8b175
Compare
obecny
reviewed
May 7, 2021
plugins/node/opentelemetry-instrumentation-router/src/version.ts
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/test/index.test.ts
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/test/index.test.ts
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
Outdated
Show resolved
Hide resolved
rauno56
force-pushed
the
feat/router-instrumentation
branch
from
3a7d6ae to
ffa6735
Compare
|
Please avoid force push after 1st review, it is impossible to track changes |
Co-authored-by: Bartlomiej Obecny <[email protected]>
Doesn't necessarily belong here, but I'll just add it since I did the same for the package in hand.
vmarchaud
reviewed
May 13, 2021
plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
Outdated
Show resolved
Hide resolved
plugins/node/opentelemetry-instrumentation-router/src/instrumentation.ts
Outdated
Show resolved
Hide resolved
|
|
||
| utils.renameHttpSpan(parentSpan, layer.method, route); | ||
| // make sure spans are ended at least when response is finished | ||
| res.prependOnceListener('finish', () => span.end()); |
There was a problem hiding this comment.
|
|
||
| utils.renameHttpSpan(parentSpan, layer.method, route); | ||
| // make sure spans are ended at least when response is finished | ||
| res.prependOnceListener('finish', () => span.end()); |
There was a problem hiding this comment.
I couldn't find the discussion in #416 but ending twice the span isn't technically a noop because its log a warning to the diag logger.
Now that isn't enabled by default isn't a problem for all users but i suspect it will for people having it enabled (see #107 or open-telemetry/opentelemetry-js#2126 for exemple).
vmarchaud
approved these changes
May 13, 2021
johnbley
approved these changes
May 17, 2021
| const deepRouter = new Router(); | ||
|
|
||
| deepRouter.use('/hello', helloRouter); | ||
| router.use('/deep', deepRouter); |
There was a problem hiding this comment.
I like the thinking behind this test (setup)!
|
@open-telemetry/javascript-maintainers Can this be merged now? |
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.
Which problem is this PR solving?
This adds auto instrumentation for pillarjs/router, which is almost identical to the router implementation used in Express.
Ideally, if possible, those two instrumentations should share code(thoughts on that?), but this is not currently the case because
Short description of the changes
Instead of wrapping each handler passed to the router, I'm patching two functions on
Layerto plug into the core of the routers work.