feat(instrumentation-mongoose): add instrumentation of static methods #2748

Vovcharaa · 2025-03-09T14:36:29Z

Which problem is this PR solving?

Currently Mongoose instrumentation does not track static methods like insertMany and bulkWrite

Short description of the changes

Added patchModelStatic to allow instrumentation of static model methods.
~~Changed tested versions of mongoose because some older versions have weird timeouts with callbacks when suppressTracing is used in tests.~~

Related issues

Fixes #2488

linux-foundation-easycla · 2025-03-09T14:36:35Z

The committers listed above are authorized under a signed CLA.

✅ login: Vovcharaa / name: Nazar Vovk (eb21cd0, 167682d, 7475099, 7bd1296, e1f15c1)

Vovcharaa · 2025-03-17T18:52:18Z

Hi @blumamir,
Is there any chance that you'll be able to review it soon?

bimmerv · 2025-03-24T13:12:59Z

Hi.
I'm also interested in this feature.

Vovcharaa · 2025-03-30T12:12:34Z

Is there anyone who can review this?
@pichlermarc

pichlermarc · 2025-04-29T08:05:36Z

Hi @Vovcharaa - @blumamir owns this component, they are the first contact point for reviews.

Regardless, a few things that stand out from a high-level perspective:

I don't think not testing certain versions is the way to go, as we'd not notice if we'd crash the end-user's app on certain versions of mongoose.
the PR is marked as breaking (! in the PR title), but the changes actually all seem non-breaking to me, what's the reason for that? 🤔

Vovcharaa · 2025-04-29T09:28:40Z

Hi @pichlermarc
I marked PR as breaking because I removed older versions from tests. I thought it is enough to mark them as not supported anymore.

blumamir

LGTM

Thank you for contributing this enhancement

blumamir · 2025-05-07T13:20:56Z

please also update the new version range:

in README
in patch definitions

codecov · 2025-05-07T13:27:11Z

Codecov Report

Attention: Patch coverage is 86.48649% with 5 lines in your changes missing coverage. Please review.

Project coverage is 89.68%. Comparing base (11a2999) to head (e1f15c1).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...gins/node/instrumentation-mongoose/src/mongoose.ts	85.71%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2748      +/-   ##
==========================================
- Coverage   89.69%   89.68%   -0.02%     
==========================================
  Files         184      184              
  Lines        8966     9003      +37     
  Branches     1835     1845      +10     
==========================================
+ Hits         8042     8074      +32     
- Misses        924      929       +5

Files with missing lines	Coverage Δ
plugins/node/instrumentation-mongoose/src/utils.ts	`76.08% <100.00%> (+1.08%)`	⬆️
...gins/node/instrumentation-mongoose/src/mongoose.ts	`94.70% <85.71%> (-2.34%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Vovcharaa · 2025-05-08T13:36:51Z

@pichlermarc @blumamir Could you pls allow tests to run?

Vovcharaa · 2025-05-17T14:48:44Z

@pichlermarc @blumamir, for some unknown reason, suppressTracing works weird with callback tests. It suppresses what it should not. I fixed it by enabling instrumentation after injecting test data into the database to avoid using suppressTracing in tests.

Vovcharaa · 2025-05-19T14:31:08Z

@pichlermarc As I see @blumamir quite rarely reviews PRs in this repo, could you, please, approve tests and merge this PR in case everything is good? This PR already has component owner approval.

plugins/node/instrumentation-mongoose/src/mongoose.ts

plugins/node/instrumentation-mongoose/test/user.ts

david-luna · 2025-05-19T16:35:17Z

plugins/node/instrumentation-mongoose/src/types.ts

@@ -23,6 +23,8 @@ export interface SerializerPayload {
  document?: any;
  aggregatePipeline?: any;
  fields?: any;
+  documents?: any;


(not for this PR): I guess the payload properties depend on the operation being serialized. This type and DbStatementSerializer could be improved by using a union on the type property and a specific type per opration in payload. This way we provide some hints to the devs who want to implement a serializer

Check this small example in TS playground.

david-luna · 2025-05-19T16:52:13Z

plugins/node/instrumentation-mongoose/src/mongoose.ts

@@ -99,7 +99,7 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
  protected init(): InstrumentationModuleDefinition {
    const module = new InstrumentationNodeModuleDefinition(
      'mongoose',
-      ['>=5.9.7 <9'],


the description of the PR states

Changed tested versions of mongoose because some older versions have weird timeouts with callbacks when suppressTracing is used in tests.

But here is actually dropping support for a range of versions (>=6 <6.7.5) :(
What are exactly the test issues you're facing?

I fixed one issue with callbacks when there are 3 args on these versions, but the issue with suppressTracing remains on them.
If loadUsers is called after instrumentation is enabled and is wrapped in suppressTracing, spans in callback tests are not created (or ended).

david-luna · 2025-05-19T16:54:16Z

plugins/node/instrumentation-mongoose/test/mongoose-common.test.ts

@@ -321,6 +321,107 @@ describe('mongoose instrumentation [common]', () => {
    expect(statement.document).toEqual(expect.objectContaining(document));
  });

+  it('instrumenting insertMany operation', async () => {


There is not test with options or callback params. Is it possible to ad one test for these cases?

Added for insertMany.
This helped identify the issue with versions that I dropped support for.

Vovcharaa · 2025-05-19T20:13:30Z

plugins/node/instrumentation-mongoose/src/utils.ts

+  } else if (args.length === 3){
+    callbackArgumentIndex = 2;


This is the fix for insertMany/bulkWrite with callback and options.
It also fixed issues with older versions, which I previously dropped from support.

Vovcharaa requested a review from a team as a code owner March 9, 2025 14:36

github-actions bot added the pkg:instrumentation-mongoose label Mar 9, 2025

github-actions bot assigned blumamir Mar 9, 2025

github-actions bot requested a review from blumamir March 9, 2025 14:36

Vovcharaa force-pushed the mongoose-static-method-tracing branch from 60804e1 to cd106dc Compare April 28, 2025 19:37

Vovcharaa force-pushed the mongoose-static-method-tracing branch from cd106dc to 62e5b65 Compare May 7, 2025 12:41

blumamir approved these changes May 7, 2025

View reviewed changes

Vovcharaa force-pushed the mongoose-static-method-tracing branch 2 times, most recently from bfac69d to edbb3ff Compare May 8, 2025 13:36

Vovcharaa force-pushed the mongoose-static-method-tracing branch from edbb3ff to 979415c Compare May 17, 2025 14:44

david-luna reviewed May 19, 2025

View reviewed changes

Vovcharaa changed the title ~~feat(instrumentation-mongoose)!: add instrumentation of static methods~~ feat(instrumentation-mongoose): add instrumentation of static methods May 19, 2025

Vovcharaa added 3 commits May 19, 2025 22:59

feat(instrumentation-mongoose)!: add instrumentation of static methods

eb21cd0

fix tests

7475099

latest fixes and additional tests

167682d

Vovcharaa force-pushed the mongoose-static-method-tracing branch from 72c0f52 to 167682d Compare May 19, 2025 19:59

readme fix

7bd1296

Vovcharaa commented May 19, 2025

View reviewed changes

lint

e1f15c1

david-luna approved these changes May 20, 2025

View reviewed changes

david-luna merged commit 55cc256 into open-telemetry:main May 20, 2025
29 of 30 checks passed

dyladan mentioned this pull request May 20, 2025

chore: release main #2834

Open

Vovcharaa deleted the mongoose-static-method-tracing branch May 20, 2025 11:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(instrumentation-mongoose): add instrumentation of static methods #2748

feat(instrumentation-mongoose): add instrumentation of static methods #2748

Vovcharaa commented Mar 9, 2025 •

edited

Loading

linux-foundation-easycla bot commented Mar 9, 2025 •

edited

Loading

Vovcharaa commented Mar 17, 2025

bimmerv commented Mar 24, 2025

Vovcharaa commented Mar 30, 2025

pichlermarc commented Apr 29, 2025

Vovcharaa commented Apr 29, 2025

blumamir left a comment

blumamir commented May 7, 2025

codecov bot commented May 7, 2025 •

edited

Loading

Vovcharaa commented May 8, 2025

Vovcharaa commented May 17, 2025

Vovcharaa commented May 19, 2025

david-luna May 19, 2025

david-luna May 19, 2025

Vovcharaa May 19, 2025

david-luna May 19, 2025

Vovcharaa May 19, 2025

Vovcharaa May 19, 2025

feat(instrumentation-mongoose): add instrumentation of static methods #2748

feat(instrumentation-mongoose): add instrumentation of static methods #2748

Conversation

Vovcharaa commented Mar 9, 2025 • edited Loading

Which problem is this PR solving?

Short description of the changes

Related issues

linux-foundation-easycla bot commented Mar 9, 2025 • edited Loading

Vovcharaa commented Mar 17, 2025

bimmerv commented Mar 24, 2025

Vovcharaa commented Mar 30, 2025

pichlermarc commented Apr 29, 2025

Vovcharaa commented Apr 29, 2025

blumamir left a comment

Choose a reason for hiding this comment

blumamir commented May 7, 2025

codecov bot commented May 7, 2025 • edited Loading

Codecov Report

Vovcharaa commented May 8, 2025

Vovcharaa commented May 17, 2025

Vovcharaa commented May 19, 2025

david-luna May 19, 2025

Choose a reason for hiding this comment

david-luna May 19, 2025

Choose a reason for hiding this comment

Vovcharaa May 19, 2025

Choose a reason for hiding this comment

david-luna May 19, 2025

Choose a reason for hiding this comment

Vovcharaa May 19, 2025

Choose a reason for hiding this comment

Vovcharaa May 19, 2025

Choose a reason for hiding this comment

Vovcharaa commented Mar 9, 2025 •

edited

Loading

linux-foundation-easycla bot commented Mar 9, 2025 •

edited

Loading

codecov bot commented May 7, 2025 •

edited

Loading