URL parameterization not taking into account express routers in v8

[richardsimko]

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

8.0.0

Framework Version

Node: 20.12.2
Express: 4.19.2

Link to Sentry event

https://fl101.sentry.io/performance/trace/9bd6ae8a599b0919ccd1941defbcb6f5

SDK Setup

Sentry.init({dsn: process.env.SENTRY_DSN})

Steps to Reproduce

Mount a router with the following:

const apiRoutes = express.Router();
const fooApiRoutes = express.Router();

fooApiRoutes.get('/foo',() => {
});

apiRoutes.use(fooApiRoutes);

app.use('/api', apiRoutes);

Expected Result

Calls to GET /api/foo should be parameterized as such.

Trace collected with 7.x: https://fl101.sentry.io/performance/trace/9f106d65ff644716b32603965c85b61c/?node=span-a36c5a350b874100&node=txn-98cdcb0f6770474aaa27709f1adfe49b&statsPeriod=14d&timestamp=1715939877

Actual Result

They are presented as /foo.

Trace collected with 8.x: https://fl101.sentry.io/performance/trace/9bd6ae8a599b0919ccd1941defbcb6f5/?fov=0%2C112.99991607666016&node=txn-3ead7993a2bf44b99dc67e857ae743ec&statsPeriod=14d&timestamp=1715938309

[mydea]

Hey, thanks for reporting this.
It seems there are still some rough spots in the new express instrumentation. We'll work on updating this to get back to full feature parity there!

cc @onurtemizkan what is the status for this, do you remember?

[onurtemizkan]

Thanks for reporting this @richardsimko,

Are you using multiple or nested router instances, and if so, what's the node version you're using?

The last discussion was about some gaps in node versions lower than 16. We can try to fix this upstream on opentelemetry repository.

Could you provide a minimal reproduction if possible, so we can be sure that use is properly covered in the patch?

[mydea]

Ah yeah, and related question: What node version do you use?

[richardsimko]

Oh I thought I put that in the issue, sorry! I'm using Node 20.12.2 and Express 4.19.2. I updated the issue with this as well.

We are indeed using two levels of routers now that I check more closely, I've updated the example to reflect our real usage.

[AbhiPrasad]

Yeah we validated this with https://github.com/getsentry/chartcuterie/ - an express service we run in Sentry itself. We'll need to make some upstream changes to OpenTelemetry to fix this!

[choxnox]

Is there any ETA on this?

[AbhiPrasad]

This is tracked upstream with open-telemetry/opentelemetry-js-contrib#1993 - we need to fix it with OpenTelemetry!

no ETA atm, but we have someone on our side taking a look this week.

[AbhiPrasad]

PR: open-telemetry/opentelemetry-js-contrib#2319

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #13948, which was included in the 8.35.0-beta.0 release.