Mongoose instrumentation does not work for Mongoose >= 7

[jennyunh]

Environment

SaaS (https://sentry.io/)

What are you trying to accomplish?

I've added in the appropriate database integrations to see db queries in my transactions:
https://docs.sentry.io/platforms/node/performance/database/

How are you getting stuck?

Database queries are not being detected and showing up for some transactions.

Sentry initialization:

import * as Sentry from "@sentry/node";
import {ProfilingIntegration} from "@sentry/profiling-node";
import {sentryAddMetrics} from "@/middleware/sentryAddMetrics";

export function initSentry(app): void {
    const isProd = process.env.REACT_APP_ENVIRONMENT === "production";
    Sentry.init({
        dsn: "...",
        environment: process.env.REACT_APP_ENVIRONMENT,
        integrations: [
           
            new ProfilingIntegration(),
            new Sentry.Integrations.Express({
                // to trace all requests to the default router
                app
            }),
            new Sentry.Integrations.Mongo({
                useMongoose: true
            }),
            new Sentry.Integrations.Http({tracing: true})
        ],
        beforeSend: (event, hint) => {
            const error: any = hint.originalException;

            if (error && (
                (error.status && error.status < 500) ||
                (error.httpStatus && error.httpStatus < 500)
            )) {
                return null
            }

            return event;
        },

        // Performance Monitoring
        tracesSampleRate: isProd ? 0.1 : 1.0,
        // Set sampling rate for profiling - this is relative to tracesSampleRate
        profilesSampleRate: 1.0,
    });
    app.use(Sentry.Handlers.requestHandler())
    app.use(Sentry.Handlers.tracingHandler())

    app.use(sentryAddMetrics);

}

No db queries:

Has db queries:

Where in the product are you?

Performance

Link

No response

DSN

https://524f54dda82743f3445b4f28533ef38d@o4505830066159616.ingest.sentry.io/4505869944881152

Version

No response

[getsantry]

Assigning to @getsentry/support for routing ⏲️

[Lms24]

Hey @jennyunh thanks for writing in!
Can you provide some further information about this behaviour:

• Which SDK version are you using?
• Any chance that the express endpoints don't always execute the db queries?
• Could you link a Sentry event which should contain db spans but doesn't?
• Most importantly: Is this reproducible in a minimal scenario? If yes please provide a minimal reproducible example?

We're currently working on the next SDK major version (v8) which should increase the quality of our express and DB integration spans because we're using OpentTelemetry instrumentation. Currently, we're still in an alpha state but we're targetting a beta in the next days. Might be worth checking out to see if this behaviour resolved itself.

[jennyunh]

Hi, thank you for your response.
To address your points:

• I am using:
  "@sentry/node": "^7.109.0",
  "@sentry/profiling-node": "^1.3.5"

• A Sentry event that should contain db spans but doesn't:

Event id: 4c43068ccb864d8c967645b310452075

• Here is a minimal API. This API's transaction event is shown in the screenshot above. As you can see, no db spans appear:

app.put("/users/update-profile", userAuthentication, async (req: Request<any, UpdateProfileBody>, res: Response) => {
    const {
        email,
        phoneNumber: phoneNumberBody,
        firstName,
        lastName,
    } = req.body;
    
   await UserModel.findByIdAndUpdate(req.user._id, {
        email,
        firstName,
        lastName,
        updatedAt: Date.now()
    });

    const theUser = await UserModel.findOne({_id: req.user._id});

    console.log(theUser);

    res.sendStatus(200);
})

Appreciate the heads-up on the next version and upcoming beta.