feat(instrumentation-express): Add support for Express v5

plugins/node/opentelemetry-instrumentation-express/src/instrumentation.ts

@@ -61,41 +61,63 @@
         'express',
         ['>=4.0.0 <5'],
         moduleExports => {
-          const routerProto = moduleExports.Router as unknown as express.Router;
-          // patch express.Router.route
-          if (isWrapped(routerProto.route)) {
-            this._unwrap(routerProto, 'route');
-          }
-          this._wrap(routerProto, 'route', this._getRoutePatch());
-          // patch express.Router.use
-          if (isWrapped(routerProto.use)) {
-            this._unwrap(routerProto, 'use');
-          }
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          this._wrap(routerProto, 'use', this._getRouterUsePatch() as any);
-          // patch express.Application.use
-          if (isWrapped(moduleExports.application.use)) {
-            this._unwrap(moduleExports.application, 'use');
-          }
-          this._wrap(
-            moduleExports.application,
-            'use',
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            this._getAppUsePatch() as any
-          );
-          return moduleExports;
+          this._setup(moduleExports, false);
+        },
+        moduleExports => {
+          this._tearDown(moduleExports, false);
+        }
+      ),
+      new InstrumentationNodeModuleDefinition(
+        'express',
+        ['>=5 <6'],
+        moduleExports => {
+          this._setup(moduleExports, true);
         },
         moduleExports => {
-          if (moduleExports === undefined) return;
-          const routerProto = moduleExports.Router as unknown as express.Router;
-          this._unwrap(routerProto, 'route');
-          this._unwrap(routerProto, 'use');
-          this._unwrap(moduleExports.application, 'use');
+          this._tearDown(moduleExports, true);
         }
       ),
     ];
   }
 
+  private _setup(moduleExports: any, isExpressV5: boolean) {
+    const routerProto = isExpressV5
+      ? moduleExports.Router.prototype
+      : moduleExports.Router;
+    // patch express.Router.route
+    if (isWrapped(routerProto.route)) {
+      this._unwrap(routerProto, 'route');
+    }
+    this._wrap(routerProto, 'route', this._getRoutePatch());
+    // patch express.Router.use
+    if (isWrapped(routerProto.use)) {
+      this._unwrap(routerProto, 'use');
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    this._wrap(routerProto, 'use', this._getRouterUsePatch() as any);
+    // patch express.Application.use
+    if (isWrapped(moduleExports.application.use)) {
+      this._unwrap(moduleExports.application, 'use');
+    }
+    this._wrap(
+      moduleExports.application,
+      'use',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this._getAppUsePatch(isExpressV5) as any
+    );
+    return moduleExports;
+  }
+
+  private _tearDown(moduleExports: any, isExpressV5: boolean) {
+    if (moduleExports === undefined) return;
+    const routerProto = isExpressV5
+      ? moduleExports.Router.prototype
+      : moduleExports.Router;
+    this._unwrap(routerProto, 'route');
+    this._unwrap(routerProto, 'use');
+    this._unwrap(moduleExports.application, 'use');
+  }
+
   /**
    * Get the patch for Router.route function
    */
@@ -135,16 +157,22 @@
   /**
    * Get the patch for Application.use function
    */
-  private _getAppUsePatch() {
+  private _getAppUsePatch(isExpressV5: boolean) {
     const instrumentation = this;
     return function (original: express.Application['use']) {
       return function use(
-        this: { _router: ExpressRouter },
+        // In express 5.x the router is stored in `router` whereas in 4.x it's stored in `_router`
+        this: { _router?: ExpressRouter; router?: ExpressRouter },
         ...args: Parameters<typeof original>
       ) {
+        // if we access app.router in express 4.x we trigger an assertion error
+        // This property existed in v3, was removed in v4 and then re-added in v5
+        const router = isExpressV5 ? this.router : this._router;
         const route = original.apply(this, args);
-        const layer = this._router.stack[this._router.stack.length - 1];
-        instrumentation._applyPatch(layer, getLayerPath(args));
+        if (router) {
+          const layer = router.stack[router.stack.length - 1];
+          instrumentation._applyPatch(layer, getLayerPath(args));
+        }
         return route;
       };
     };

plugins/node/opentelemetry-instrumentation-express/src/internal-types.ts

@@ -15,7 +15,6 @@
  */
 
 import type { Request } from 'express';
-import { Attributes } from '@opentelemetry/api';
 
 /**
  * This symbol is used to mark express layer as being already instrumented
@@ -48,11 +47,6 @@ export type PathParams = string | RegExp | Array<string | RegExp>;
 
 // https://github.com/expressjs/express/blob/main/lib/router/index.js#L53
 export type ExpressRouter = {
-  params: { [key: string]: string };
-  _params: string[];
-  caseSensitive: boolean;
-  mergeParams: boolean;
-  strict: boolean;
   stack: ExpressLayer[];
 };
 
@@ -61,13 +55,6 @@ export type ExpressLayer = {
   handle: Function & Record<string, any>;
   [kLayerPatched]?: boolean;
   name: string;
-  params: { [key: string]: string };
   path: string;
-  regexp: RegExp;
   route?: ExpressLayer;
 };
-
-export type LayerMetadata = {
-  attributes: Attributes;
-  name: string;
-};

plugins/node/opentelemetry-instrumentation-express/src/utils.ts

@@ -91,7 +91,7 @@ export const getLayerMetadata = (
       },
       name: `router - ${extractedRouterPath}`,
     };
-  } else if (layer.name === 'bound dispatch') {
+  } else if (layer.name === 'bound dispatch' || layer.name === 'handle') {
     return {
       attributes: {
         [AttributeNames.EXPRESS_NAME]:

plugins/node/opentelemetry-instrumentation-express/test/custom-config.test.ts → plugins/node/opentelemetry-instrumentation-express/test/v4/custom-config.test.ts

@@ -24,9 +24,12 @@ import {
 import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import * as assert from 'assert';
 import { RPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
-import { ExpressLayerType } from '../src/enums/ExpressLayerType';
-import { AttributeNames } from '../src/enums/AttributeNames';
-import { ExpressInstrumentation, ExpressInstrumentationConfig } from '../src';
+import { ExpressLayerType } from '../../src/enums/ExpressLayerType';
+import { AttributeNames } from '../../src/enums/AttributeNames';
+import {
+  ExpressInstrumentation,
+  ExpressInstrumentationConfig,
+} from '../../src';
 import { createServer, httpRequest } from './utils';
 
 const instrumentation = new ExpressInstrumentation({

plugins/node/opentelemetry-instrumentation-express/test/express.test.ts → plugins/node/opentelemetry-instrumentation-express/test/v4/express.test.ts

@@ -22,8 +22,8 @@ import {
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
 import * as assert from 'assert';
-import { AttributeNames } from '../src/enums/AttributeNames';
-import { ExpressInstrumentation } from '../src';
+import { AttributeNames } from '../../src/enums/AttributeNames';
+import { ExpressInstrumentation } from '../../src';
 import { createServer, httpRequest, serverWithMiddleware } from './utils';
 import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import * as testUtils from '@opentelemetry/contrib-test-utils';

plugins/node/opentelemetry-instrumentation-express/test/fixtures/use-express-nested-router.mjs → plugins/node/opentelemetry-instrumentation-express/test/v4/fixtures/use-express-nested-router.mjs

@@ -18,7 +18,7 @@ import { promisify } from 'util';
 import { createTestNodeSdk } from '@opentelemetry/contrib-test-utils';
 
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { ExpressInstrumentation } from '../../build/src/index.js';
+import { ExpressInstrumentation } from '../../../build/src/index.js';
 
 const sdk = createTestNodeSdk({
   serviceName: 'use-express-nested',

plugins/node/opentelemetry-instrumentation-express/test/fixtures/use-express-regex.mjs → plugins/node/opentelemetry-instrumentation-express/test/v4/fixtures/use-express-regex.mjs

@@ -21,7 +21,7 @@ import { promisify } from 'util';
 import { createTestNodeSdk } from '@opentelemetry/contrib-test-utils';
 
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { ExpressInstrumentation } from '../../build/src/index.js';
+import { ExpressInstrumentation } from '../../../build/src/index.js';
 
 const sdk = createTestNodeSdk({
   serviceName: 'use-express-regex',

plugins/node/opentelemetry-instrumentation-express/test/fixtures/use-express-router.mjs → plugins/node/opentelemetry-instrumentation-express/test/v4/fixtures/use-express-router.mjs

@@ -18,7 +18,7 @@ import { promisify } from 'util';
 import { createTestNodeSdk } from '@opentelemetry/contrib-test-utils';
 
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { ExpressInstrumentation } from '../../build/src/index.js';
+import { ExpressInstrumentation } from '../../../build/src/index.js';
 
 const sdk = createTestNodeSdk({
   serviceName: 'use-express-nested',

plugins/node/opentelemetry-instrumentation-express/test/fixtures/use-express.mjs → plugins/node/opentelemetry-instrumentation-express/test/v4/fixtures/use-express.mjs

@@ -21,15 +21,12 @@ import { promisify } from 'util';
 import { createTestNodeSdk } from '@opentelemetry/contrib-test-utils';
 
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { ExpressInstrumentation } from '../../build/src/index.js';
+import { ExpressInstrumentation } from '../../../build/src/index.js';
 
 const sdk = createTestNodeSdk({
   serviceName: 'use-express',
-  instrumentations: [
-    new HttpInstrumentation(),
-    new ExpressInstrumentation()
-  ]
-})
+  instrumentations: [new HttpInstrumentation(), new ExpressInstrumentation()],
+});
 sdk.start();
 
 import express from 'express';

plugins/node/opentelemetry-instrumentation-express/test/hooks.test.ts → plugins/node/opentelemetry-instrumentation-express/test/v4/hooks.test.ts

@@ -24,9 +24,9 @@ import {
 import * as assert from 'assert';
 import type * as http from 'http';
 import * as sinon from 'sinon';
-import { ExpressInstrumentation } from '../src';
-import { ExpressRequestInfo, SpanNameHook } from '../src/types';
-import { ExpressLayerType } from '../src/enums/ExpressLayerType';
+import { ExpressInstrumentation } from '../../src';
+import { ExpressRequestInfo, SpanNameHook } from '../../src/types';
+import { ExpressLayerType } from '../../src/enums/ExpressLayerType';
 import { SEMATTRS_HTTP_METHOD } from '@opentelemetry/semantic-conventions';
 
 const instrumentation = new ExpressInstrumentation();

plugins/node/opentelemetry-instrumentation-express/test/ignore-all.test.ts → plugins/node/opentelemetry-instrumentation-express/test/v4/ignore-all.test.ts

@@ -23,8 +23,8 @@ import {
 } from '@opentelemetry/sdk-trace-base';
 import * as assert from 'assert';
 import { RPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
-import { AttributeNames } from '../src/enums/AttributeNames';
-import { ExpressInstrumentation, ExpressLayerType } from '../src';
+import { AttributeNames } from '../../src/enums/AttributeNames';
+import { ExpressInstrumentation, ExpressLayerType } from '../../src';
 import { createServer, httpRequest } from './utils';
 
 const instrumentation = new ExpressInstrumentation({