feat: MongoDB Tracing Support

[kamilogorek]

MongoDB tracing support.

Usage:

const Sentry = require("@sentry/node");
const Tracing = require("@sentry/tracing");
const mongodb = require("mongodb");

Sentry.init({
  dsn: "__PUBLIC_DSN__",
  integrations: [
    new Tracing.Integrations.Mongo(),
  ],
  tracesSampleRate: 1.0,
});

const client = new mongodb.MongoClient("mongodb://mongo:docker@localhost:27017");

// the rest of the code, for raw-node code we need manual instrumentation, eg.

async function run() {
  const transaction = Sentry.startTransaction({
    op: "transaction",
    name: "My Transaction",
  });

  Sentry.configureScope((scope) => {
    scope.setSpan(transaction);
  });

  try {
    await client.connect();
    
    const database = await client.db("admin");  
    const collection = database.collection("movies");

    await collection.insertOne({ title: "Rick and Morty" });
    await collection.findOne({ title: "Back to the Future" });
    await collection.updateOne(
      { title: "Back to the Future" },
      { $set: { title: "South Park" } }
    );
    await collection.findOne({ title: "South Park" });
  } finally {
    if (transaction) transaction.finish();
    await client.close();
  }
}
run().catch(console.dir);

Works nicely with Express too:

const Sentry = require("@sentry/node");
const Tracing = require("@sentry/tracing");
const mongodb = require("mongodb");
const express = require("express");

Sentry.init({
  dsn: "__PUBLIC_DSN__",
  integrations: [
    new Sentry.Integrations.Http({ tracing: true }),
    new Tracing.Integrations.Express({
      app: express.Router,
      methods: ["get"],
    }),
    new Tracing.Integrations.Mongo(),
  ],
  tracesSampleRate: 1.0,
});

const app = express();
const client = new mongodb.MongoClient("mongodb://mongo:docker@localhost:27017");
client.connect();

app.use(Sentry.Handlers.requestHandler());
app.use(Sentry.Handlers.tracingHandler());
app.use(express.json());

app.get("/hi", async function sayHi(req, res, next) {
  try {
    const database = await client.db("admin");  
    const collection = database.collection("movies");
    await collection.insertOne({ title: "Rick and Morty" });
    const result = await collection.findOne({ title: "Rick and Morty" });
    res.send(result);
  } catch (err) {
    next(err);
  }
});

app.use(Sentry.Handlers.errorHandler());

app.listen(3000);

[github-actions]

size-limit report

Path	Size
@sentry/browser - CDN Bundle (gzipped)	19.73 KB (-0.01% 🔽)
@sentry/browser - Webpack	20.6 KB (0%)
@sentry/react - Webpack	20.6 KB (0%)
@sentry/browser + @sentry/tracing - CDN Bundle (gzipped)	26.88 KB (0%)

[lobsterkatie]

Why pass in getCurrentHub?

[HazAT]

This is how integrations work internally, the function will be injected from outside and we should use that vs. global getCurrentHub.

[lobsterkatie]

Is "describe" your word or theirs? If it's yours, I wonder if we might name this option differently, to a) differentiate it from the description field in a transaction, and b) indicate that what it's really about is recording the operation's inputs.

[HazAT]

I think describe is used in database lingo.

[HazAT]

Merging this now, has also few other fixes.

[Copdate-Copdate]

Hi, question about MongoDB support.

I'm currently using Mongoose inside an Express app and when adding new Tracing.Integrations.Mongo() to integrations array in Sentry.init, I got the following error:

UnhandledPromiseRejectionWarning: TypeError: Tracing.Integrations.Mongo is not a constructor

Do I have to pass some config or it just doesn't support Mongoose right now?

[sol-austin]

I can't seem to get this working with Mongoose. I've added Tracing.Integrations.Mongo() to the integrations array without receiving an error message but it doesn't seem to be tracking database requests at all.

Has anyone successfully got this working with Mongoose yet?

[KevinEdry]

Same here, would love to see mongoose support for this.