MySQL integration for @sentry/node does not create any spans

[mydea]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/node

SDK Version

7.65.0

Framework Version

No response

Link to Sentry event

No response

SDK Setup

const Sentry = require("@sentry/node");
const { ProfilingIntegration } = require("@sentry/profiling-node");

Sentry.init({
  dsn: process.env.SENTRY_DSN,
  debug: true,
  tracesSampleRate: 1,
  profilesSampleRate: 1,
  integrations: [
    ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
    new ProfilingIntegration(),
  ]
});

Steps to Reproduce

An express route like this:

 app.get("/test-mysql",async  function (req, res) {
    const mysql = require('mysql');
    const connection =  mysql.createConnection({
      host: 'localhost',
      user: 'root',
      database: 'test-app',
      password: 'password'
    });

    const movies = [];
    for(let i = 1; i <= 15; i++) {
      const rows = await new Promise((resolve, reject) => {
        connection.query(
          'SELECT * FROM `movies` WHERE `title` = ?',
          [`Joker${i}`],
          function (error, results, fields) {
            if (error) {
              return reject(error);
            }

            resolve(results);
          }
        );
      });


      movies.push(...rows);
    }

    connection.end();

    res.send({ movies });
  });

Expected Result

Should get DB spans.

Actual Result

Does not generate any DB spans.

Sentry Logger [log]: [Tracing] starting http.server transaction - GET /test-mysql
Sentry Logger [log]: [Profiling] started profiling transaction: GET /test-mysql
Sentry Logger [log]: [Profiling] stopped profiling of transaction: GET /test-mysql
Sentry Logger [log]: [Tracing] Finishing http.server transaction: GET /test-mysql.

[AleshaOleg]

Hi @mydea! I think the issue is about profiling, right? I created test project with this code:

const express = require("express");
const app = express();
const port = 3000;

const Sentry = require("@sentry/node");
const { logger } = require("@sentry/utils");
const { ProfilingIntegration } = require("@sentry/profiling-node");

Sentry.init({
  dsn: "https://19928d13f5adf0e8a008b91ba9d6e360@o4506050201255936.ingest.sentry.io/4506050204073984",
  debug: true,
  tracesSampleRate: 1,
  profilesSampleRate: 1,
  integrations: [
    ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
    new ProfilingIntegration(),
  ],
});

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

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

app.get("/test-mysql", async function (req, res) {
  const mysql = require("mysql");
  const connection = mysql.createConnection({
    host: "localhost",
    user: "aleshaoleg",
    database: "movies",
    password: "password",
  });

  const movies = [];
  for (let i = 1; i <= 15; i++) {
    const rows = await new Promise((resolve, reject) => {
      connection.query(
        "SELECT * FROM `movies` WHERE `title` = ?",
        [`Joker${i}`],
        function (error, results, fields) {
          if (error) {
            return reject(error);
          }

          resolve(results);
        }
      );
    });

    movies.push(...rows);
  }

  connection.end();

  res.send({ movies });
});

And so far tracing worked fine for me, but not profiling. After debugging for a couple of hours, I found that logger was disabled in profiling-node and I think that's why it didn't work. At least I was able to console.log something here, but still logger didn't work. So, I created PR to enable logging in profiling-node - getsentry/profiling-node#201

Let me know what you think! Thanks!

[mydea]

Thanks for submitting that PR! Profiling folks will review the PR in the profiling-node repo 🙏
This issue was about actually spans not being generated for mysql. But not sure if I can still repro this, maybe it was some weird setup issue 🤔 I'm gonna close this for now (and will reopen if I still see this).

[JonasBa]

@mydea @AleshaOleg - I lack some context on this, but why would enabling the logger enable spans generation and why do we need to do this in the profiling package?

[AleshaOleg]

I was trying to fix the bug described here and seems like there was no problem with tracing. However, I had issues with profiling as I wasn't receiving any logs from profiling-node and I decided to dive into it and look at what happens there. In my case (code above) I wasn't receiving profiling logs because for some reason enabled flag was false, and only for profiling. So, I decided to check if it would work if I'll enable it. And created PR, to ask you guys why it's like that and maybe it somehow will help to fix the issue, without knowing it's not a case anymore.

I know it's not the best place to do it inside the profiling package, as I saw enabling of it in @sentry/core. In general, I didn't know issue with profiling was related to MySQL only or was a generic thing.

Now I do not understand why other integrations log information for me, but not profiling-node. I'll figure it out, probably just missing something. I will close PR as seems it's not a case for anybody else.