Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(instrumentation-express): propagate context and measure full handler spans #2638

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(instrumentation-express): propagate context and measure full handler spans #2638

wants to merge 1 commit into from

Conversation

raphael-theriault-swi
Copy link
Contributor

Which problem is this PR solving?

Currently the Express instrumentation does not propagate context and does not properly instrument request handlers.

Short description of the changes

Context is propagated for middleware and request handler spans, while their next callback is reset to the parent context to avoid extreme nesting as suggested in #2022. Request handler spans are also no longer ended prematurely.

Router spans are kept as-is since they are broken and propagating context for them would make things even more confusing than they already are.

Example traces

Before

example trace before the changes

After

example trace after the changes

Related issues

@raphael-theriault-swi raphael-theriault-swi requested a review from a team as a code owner January 10, 2025 19:52
@raphael-theriault-swi
Copy link
Contributor Author

cc @pichlermarc fixes discussed wednesday

@codecov Codecov
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.79%. Comparing base (12ee8db) to head (8d6662f).
Report is 4 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #2638   +/-   ##
=======================================
  Coverage   90.78%   90.79%           
=======================================
  Files         169      169           
  Lines        8056     8062    +6     
  Branches     1643     1645    +2     
=======================================
+ Hits         7314     7320    +6     
  Misses        742      742
Files with missing lines Coverage Δ
...try-instrumentation-express/src/instrumentation.ts 98.61% <100.00%> (+0.02%) ⬆️

... and 1 file with indirect coverage changes

@onurtemizkan onurtemizkan mentioned this pull request Jan 13, 2025
Closed
@faranak-cs faranak-cs mentioned this pull request Jan 13, 2025
Open
pichlermarc
pichlermarc approved these changes Jan 16, 2025
View reviewed changes
Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks good, thank you for working on this. 🙌
cc @JamieDanielson and @pkanal (component owners) for comments :)

@mikesir87
Copy link

Apologies for the outsider coming in on this PR, but reporting that I've manually applied this PR into a local working copy to validate it works with my sample apps and it worked! In fact, it already helped me catch a case or two where I was missing an await call on a Kafka publish or DB update that was running after the request handler had returned. Excited to see this contribution! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pichlermarc pichlermarc pichlermarc approved these changes

@deejay1 deejay1 deejay1 approved these changes

@JamieDanielson JamieDanielson Awaiting requested review from JamieDanielson

@pkanal pkanal Awaiting requested review from pkanal

Assignees

@pkanal pkanal

@JamieDanielson JamieDanielson

Labels
pkg:instrumentation-express
Projects
None yet
Milestone
No milestone
6 participants
@raphael-theriault-swi @mikesir87 @deejay1 @pichlermarc @pkanal @JamieDanielson