@opentelemetry/instrumentation-express 0.25.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,94 @@
+# OpenTelemetry Express Instrumentation for Node.js
+
+[![NPM Published Version][npm-img]][npm-url]
+[![dependencies][dependencies-image]][dependencies-url]
+[![devDependencies][devDependencies-image]][devDependencies-url]
+[![Apache License][license-image]][license-image]
+
+This module provides automatic instrumentation for [`express`](https://github.com/expressjs/express).
+
+For automatic instrumentation see the
+[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
+
+## Installation
+
+This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will not see any spans being exported from the instrumentation.
+
+```bash
+npm install --save @opentelemetry/instrumentation-http @opentelemetry/instrumentation-express
+```
+
+### Supported Versions
+
+- `^4.0.0`
+
+## Usage
+
+OpenTelemetry Express Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.
+
+To load the instrumentation, specify it in the Node Tracer's configuration:
+
+```js
+const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
+const { ExpressInstrumentation } = require('@opentelemetry/instrumentation-express');
+
+const provider = new NodeTracerProvider();
+provider.register();
+
+registerInstrumentations({
+  instrumentations: [
+    // Express instrumentation expects HTTP layer to be instrumented
+    new HttpInstrumentation(),
+    new ExpressInstrumentation(),
+  ],
+});
+```
+
+See [examples/express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/express) for a short example.
+
+### Caveats
+
+Because of the way express works, it's hard to correctly compute the time taken by asynchronous middlewares and request handlers. For this reason, the time you'll see reported for asynchronous middlewares and request handlers still only represent the synchronous execution time, and **not** any asynchronous work.
+
+### Express Instrumentation Options
+
+Express instrumentation has few options available to choose from. You can set the following:
+
+| Options | Type | Example | Description |
+| ------- | ---- | ------- | ----------- |
+| `ignoreLayers` | `IgnoreMatcher[]` | `[/^\/_internal\//]` | Ignore layers that by match. |
+| `ignoreLayersType`| `ExpressLayerType[]` | `['request_handler']` | Ignore layers of specified type. |
+
+`ignoreLayers` accepts an array of elements of types:
+
+- `string` for full match of the path,
+- `RegExp` for partial match of the path,
+- `function` in the form of `(path) => boolean` for custom logic.
+
+`ignoreLayersType` accepts an array of following strings:
+
+- `router` is the name of `express.Router()`,
+- `middleware`,
+- `request_handler` is the name for anything that's not a router or a middleware.
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
+[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
+[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
+[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-express
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-express
+[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-express&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-express&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-dns
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-dns.svg

package/build/src/enums/AttributeNames.d.ts

@@ -0,0 +1,5 @@
+export declare enum AttributeNames {
+    EXPRESS_TYPE = "express.type",
+    EXPRESS_NAME = "express.name"
+}
+//# sourceMappingURL=AttributeNames.d.ts.map

package/build/src/enums/AttributeNames.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttributeNames = void 0;
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var AttributeNames;
+(function (AttributeNames) {
+    AttributeNames["EXPRESS_TYPE"] = "express.type";
+    AttributeNames["EXPRESS_NAME"] = "express.name";
+})(AttributeNames = exports.AttributeNames || (exports.AttributeNames = {}));
+//# sourceMappingURL=AttributeNames.js.map

package/build/src/enums/AttributeNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttributeNames.js","sourceRoot":"","sources":["../../../src/enums/AttributeNames.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,+CAA6B,CAAA;IAC7B,+CAA6B,CAAA;AAC/B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB"}

package/build/src/enums/ExpressLayerType.d.ts

@@ -0,0 +1,6 @@
+export declare enum ExpressLayerType {
+    ROUTER = "router",
+    MIDDLEWARE = "middleware",
+    REQUEST_HANDLER = "request_handler"
+}
+//# sourceMappingURL=ExpressLayerType.d.ts.map

package/build/src/enums/ExpressLayerType.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressLayerType = void 0;
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var ExpressLayerType;
+(function (ExpressLayerType) {
+    ExpressLayerType["ROUTER"] = "router";
+    ExpressLayerType["MIDDLEWARE"] = "middleware";
+    ExpressLayerType["REQUEST_HANDLER"] = "request_handler";
+})(ExpressLayerType = exports.ExpressLayerType || (exports.ExpressLayerType = {}));
+//# sourceMappingURL=ExpressLayerType.js.map

package/build/src/enums/ExpressLayerType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressLayerType.js","sourceRoot":"","sources":["../../../src/enums/ExpressLayerType.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,6CAAyB,CAAA;IACzB,uDAAmC,CAAA;AACrC,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B"}

package/build/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './instrumentation';
+export { ExpressLayerType } from './enums/ExpressLayerType';
+export { ExpressInstrumentationConfig } from './types';
+//# sourceMappingURL=index.d.ts.map

package/build/src/index.js

@@ -0,0 +1,32 @@
+"use strict";
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressLayerType = void 0;
+__exportStar(require("./instrumentation"), exports);
+var ExpressLayerType_1 = require("./enums/ExpressLayerType");
+Object.defineProperty(exports, "ExpressLayerType", { enumerable: true, get: function () { return ExpressLayerType_1.ExpressLayerType; } });
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;AAEH,oDAAkC;AAClC,6DAA4D;AAAnD,oHAAA,gBAAgB,OAAA"}

package/build/src/instrumentation.d.ts

@@ -0,0 +1,28 @@
+import * as express from 'express';
+import { ExpressInstrumentationConfig } from './types';
+import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
+/**
+ * This symbol is used to mark express layer as being already instrumented
+ * since its possible to use a given layer multiple times (ex: middlewares)
+ */
+export declare const kLayerPatched: unique symbol;
+/** Express instrumentation for OpenTelemetry */
+export declare class ExpressInstrumentation extends InstrumentationBase<typeof express> {
+    constructor(config?: ExpressInstrumentationConfig);
+    init(): InstrumentationNodeModuleDefinition<typeof express>[];
+    /**
+     * Get the patch for Router.route function
+     */
+    private _getRoutePatch;
+    /**
+     * Get the patch for Router.use function
+     */
+    private _getRouterUsePatch;
+    /**
+     * Get the patch for Application.use function
+     */
+    private _getAppUsePatch;
+    /** Patch each express layer to create span and propagate context */
+    private _applyPatch;
+}
+//# sourceMappingURL=instrumentation.d.ts.map

package/build/src/instrumentation.js

@@ -0,0 +1,208 @@
+"use strict";
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressInstrumentation = exports.kLayerPatched = void 0;
+const core_1 = require("@opentelemetry/core");
+const api_1 = require("@opentelemetry/api");
+const types_1 = require("./types");
+const ExpressLayerType_1 = require("./enums/ExpressLayerType");
+const AttributeNames_1 = require("./enums/AttributeNames");
+const utils_1 = require("./utils");
+const version_1 = require("./version");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+/**
+ * This symbol is used to mark express layer as being already instrumented
+ * since its possible to use a given layer multiple times (ex: middlewares)
+ */
+exports.kLayerPatched = Symbol('express-layer-patched');
+/** Express instrumentation for OpenTelemetry */
+class ExpressInstrumentation extends instrumentation_1.InstrumentationBase {
+    constructor(config = {}) {
+        super('@opentelemetry/instrumentation-express', version_1.VERSION, Object.assign({}, config));
+    }
+    init() {
+        return [
+            new instrumentation_1.InstrumentationNodeModuleDefinition('express', ['^4.0.0'], (moduleExports, moduleVersion) => {
+                api_1.diag.debug(`Applying patch for express@${moduleVersion}`);
+                const routerProto = moduleExports.Router;
+                // patch express.Router.route
+                if (instrumentation_1.isWrapped(routerProto.route)) {
+                    this._unwrap(routerProto, 'route');
+                }
+                this._wrap(routerProto, 'route', this._getRoutePatch());
+                // patch express.Router.use
+                if (instrumentation_1.isWrapped(routerProto.use)) {
+                    this._unwrap(routerProto, 'use');
+                }
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                this._wrap(routerProto, 'use', this._getRouterUsePatch());
+                // patch express.Application.use
+                if (instrumentation_1.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());
+                return moduleExports;
+            }, (moduleExports, moduleVersion) => {
+                if (moduleExports === undefined)
+                    return;
+                api_1.diag.debug(`Removing patch for express@${moduleVersion}`);
+                this._unwrap(moduleExports.Router.prototype, 'route');
+                this._unwrap(moduleExports.Router.prototype, 'use');
+                this._unwrap(moduleExports.application.prototype, 'use');
+            }),
+        ];
+    }
+    /**
+     * Get the patch for Router.route function
+     */
+    _getRoutePatch() {
+        const instrumentation = this;
+        return function (original) {
+            return function route_trace(...args) {
+                const route = original.apply(this, args);
+                const layer = this.stack[this.stack.length - 1];
+                instrumentation._applyPatch(layer, typeof args[0] === 'string' ? args[0] : undefined);
+                return route;
+            };
+        };
+    }
+    /**
+     * Get the patch for Router.use function
+     */
+    _getRouterUsePatch() {
+        const instrumentation = this;
+        return function (original) {
+            return function use(...args) {
+                const route = original.apply(this, args);
+                const layer = this.stack[this.stack.length - 1];
+                instrumentation._applyPatch(layer, typeof args[0] === 'string' ? args[0] : undefined);
+                return route;
+            };
+        };
+    }
+    /**
+     * Get the patch for Application.use function
+     */
+    _getAppUsePatch() {
+        const instrumentation = this;
+        return function (original) {
+            return function use(...args) {
+                const route = original.apply(this, args);
+                const layer = this._router.stack[this._router.stack.length - 1];
+                instrumentation._applyPatch.call(instrumentation, layer, typeof args[0] === 'string' ? args[0] : undefined);
+                return route;
+            };
+        };
+    }
+    /** Patch each express layer to create span and propagate context */
+    _applyPatch(layer, layerPath) {
+        const instrumentation = this;
+        // avoid patching multiple times the same layer
+        if (layer[exports.kLayerPatched] === true)
+            return;
+        layer[exports.kLayerPatched] = true;
+        this._wrap(layer, 'handle', (original) => {
+            if (original.length === 4)
+                return original;
+            return function (req, res) {
+                utils_1.storeLayerPath(req, layerPath);
+                const route = req[types_1._LAYERS_STORE_PROPERTY]
+                    .filter(path => path !== '/' && path !== '/*')
+                    .join('');
+                const attributes = {
+                    [semantic_conventions_1.SemanticAttributes.HTTP_ROUTE]: route.length > 0 ? route : '/',
+                };
+                const metadata = utils_1.getLayerMetadata(layer, layerPath);
+                const type = metadata.attributes[AttributeNames_1.AttributeNames.EXPRESS_TYPE];
+                // Rename the root http span in case we haven't done it already
+                // once we reach the request handler
+                const rpcMetadata = core_1.getRPCMetadata(api_1.context.active());
+                if (metadata.attributes[AttributeNames_1.AttributeNames.EXPRESS_TYPE] ===
+                    ExpressLayerType_1.ExpressLayerType.REQUEST_HANDLER &&
+                    (rpcMetadata === null || rpcMetadata === void 0 ? void 0 : rpcMetadata.type) === core_1.RPCType.HTTP) {
+                    rpcMetadata.span.updateName(`${req.method} ${route.length > 0 ? route : '/'}`);
+                }
+                // verify against the config if the layer should be ignored
+                if (utils_1.isLayerIgnored(metadata.name, type, instrumentation._config)) {
+                    if (type === ExpressLayerType_1.ExpressLayerType.MIDDLEWARE) {
+                        req[types_1._LAYERS_STORE_PROPERTY].pop();
+                    }
+                    return original.apply(this, arguments);
+                }
+                if (api_1.trace.getSpan(api_1.context.active()) === undefined) {
+                    return original.apply(this, arguments);
+                }
+                const span = instrumentation.tracer.startSpan(metadata.name, {
+                    attributes: Object.assign(attributes, metadata.attributes),
+                });
+                const startTime = core_1.hrTime();
+                let spanHasEnded = false;
+                // If we found anything that isnt a middleware, there no point of measuring
+                // their time since they dont have callback.
+                if (metadata.attributes[AttributeNames_1.AttributeNames.EXPRESS_TYPE] !==
+                    ExpressLayerType_1.ExpressLayerType.MIDDLEWARE) {
+                    span.end(startTime);
+                    spanHasEnded = true;
+                }
+                // listener for response.on('finish')
+                const onResponseFinish = () => {
+                    if (spanHasEnded === false) {
+                        spanHasEnded = true;
+                        span.end(startTime);
+                    }
+                };
+                // verify we have a callback
+                const args = Array.from(arguments);
+                const callbackIdx = args.findIndex(arg => typeof arg === 'function');
+                const newContext = (rpcMetadata === null || rpcMetadata === void 0 ? void 0 : rpcMetadata.type) === core_1.RPCType.HTTP
+                    ? core_1.setRPCMetadata(api_1.context.active(), Object.assign(rpcMetadata, { route: route }))
+                    : api_1.context.active();
+                if (callbackIdx >= 0) {
+                    arguments[callbackIdx] = function () {
+                        var _a;
+                        if (spanHasEnded === false) {
+                            spanHasEnded = true;
+                            (_a = req.res) === null || _a === void 0 ? void 0 : _a.removeListener('finish', onResponseFinish);
+                            span.end();
+                        }
+                        if (!(req.route && arguments[0] instanceof Error)) {
+                            req[types_1._LAYERS_STORE_PROPERTY].pop();
+                        }
+                        const callback = args[callbackIdx];
+                        return api_1.context.bind(newContext, callback).apply(this, arguments);
+                    };
+                }
+                const result = original.apply(this, arguments);
+                /**
+                 * At this point if the callback wasn't called, that means either the
+                 * layer is asynchronous (so it will call the callback later on) or that
+                 * the layer directly end the http response, so we'll hook into the "finish"
+                 * event to handle the later case.
+                 */
+                if (!spanHasEnded) {
+                    res.once('finish', onResponseFinish);
+                }
+                return result;
+            };
+        });
+    }
+}
+exports.ExpressInstrumentation = ExpressInstrumentation;
+//# sourceMappingURL=instrumentation.js.map

package/build/src/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,8CAK6B;AAC7B,4CAA0E;AAE1E,mCAMiB;AACjB,+DAA4D;AAC5D,2DAAwD;AACxD,mCAA2E;AAC3E,uCAAoC;AACpC,oEAIwC;AACxC,8EAAyE;AAEzE;;;GAGG;AACU,QAAA,aAAa,GAAkB,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAE5E,gDAAgD;AAChD,MAAa,sBAAuB,SAAQ,qCAE3C;IACC,YAAY,SAAuC,EAAE;QACnD,KAAK,CACH,wCAAwC,EACxC,iBAAO,EACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAC1B,CAAC;IACJ,CAAC;IAED,IAAI;QACF,OAAO;YACL,IAAI,qDAAmC,CACrC,SAAS,EACT,CAAC,QAAQ,CAAC,EACV,CAAC,aAAa,EAAE,aAAa,EAAE,EAAE;gBAC/B,UAAI,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAG,aAAa,CAAC,MAAmC,CAAC;gBACtE,6BAA6B;gBAC7B,IAAI,2BAAS,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;oBAChC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;iBACpC;gBACD,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;gBACxD,2BAA2B;gBAC3B,IAAI,2BAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;oBAC9B,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;iBAClC;gBACD,8DAA8D;gBAC9D,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,kBAAkB,EAAS,CAAC,CAAC;gBACjE,gCAAgC;gBAChC,IAAI,2BAAS,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;oBAC5C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;iBAChD;gBACD,IAAI,CAAC,KAAK,CACR,aAAa,CAAC,WAAW,EACzB,KAAK;gBACL,8DAA8D;gBAC9D,IAAI,CAAC,eAAe,EAAS,CAC9B,CAAC;gBACF,OAAO,aAAa,CAAC;YACvB,CAAC,EACD,CAAC,aAAa,EAAE,aAAa,EAAE,EAAE;gBAC/B,IAAI,aAAa,KAAK,SAAS;oBAAE,OAAO;gBACxC,UAAI,CAAC,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;gBAC1D,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBACpD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAC3D,CAAC,CACF;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,OAAO,UAAU,QAAiC;YAChD,OAAO,SAAS,WAAW,CAEzB,GAAG,IAAiC;gBAEpC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAiB,CAAC;gBAChE,eAAe,CAAC,WAAW,CACzB,KAAK,EACL,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAClD,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,kBAAkB;QACxB,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,OAAO,UAAU,QAA+B;YAC9C,OAAO,SAAS,GAAG,CAEjB,GAAG,IAAiC;gBAEpC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAiB,CAAC;gBAChE,eAAe,CAAC,WAAW,CACzB,KAAK,EACL,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAClD,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,OAAO,UAAU,QAAoC;YACnD,OAAO,SAAS,GAAG,CAEjB,GAAG,IAAiC;gBAEpC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAChE,eAAe,CAAC,WAAW,CAAC,IAAI,CAC9B,eAAe,EACf,KAAK,EACL,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAClD,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED,oEAAoE;IAC5D,WAAW,CAEjB,KAAmB,EACnB,SAAkB;QAElB,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,+CAA+C;QAC/C,IAAI,KAAK,CAAC,qBAAa,CAAC,KAAK,IAAI;YAAE,OAAO;QAC1C,KAAK,CAAC,qBAAa,CAAC,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,QAAkB,EAAE,EAAE;YACjD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,QAAQ,CAAC;YAC3C,OAAO,UAEL,GAAmB,EACnB,GAAqB;gBAErB,sBAAc,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;gBAC/B,MAAM,KAAK,GAAI,GAAG,CAAC,8BAAsB,CAAc;qBACpD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC;qBAC7C,IAAI,CAAC,EAAE,CAAC,CAAC;gBACZ,MAAM,UAAU,GAAmB;oBACjC,CAAC,yCAAkB,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG;iBAChE,CAAC;gBACF,MAAM,QAAQ,GAAG,wBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBACpD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAC9B,+BAAc,CAAC,YAAY,CACR,CAAC;gBAEtB,+DAA+D;gBAC/D,oCAAoC;gBACpC,MAAM,WAAW,GAAG,qBAAc,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;gBACrD,IACE,QAAQ,CAAC,UAAU,CAAC,+BAAc,CAAC,YAAY,CAAC;oBAC9C,mCAAgB,CAAC,eAAe;oBAClC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,cAAO,CAAC,IAAI,EAClC;oBACA,WAAW,CAAC,IAAI,CAAC,UAAU,CACzB,GAAG,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAClD,CAAC;iBACH;gBAED,2DAA2D;gBAC3D,IAAI,sBAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE;oBAChE,IAAI,IAAI,KAAK,mCAAgB,CAAC,UAAU,EAAE;wBACvC,GAAG,CAAC,8BAAsB,CAAc,CAAC,GAAG,EAAE,CAAC;qBACjD;oBACD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;iBACxC;gBACD,IAAI,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,KAAK,SAAS,EAAE;oBACjD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;iBACxC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC3D,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;iBAC3D,CAAC,CAAC;gBACH,MAAM,SAAS,GAAG,aAAM,EAAE,CAAC;gBAC3B,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,2EAA2E;gBAC3E,4CAA4C;gBAC5C,IACE,QAAQ,CAAC,UAAU,CAAC,+BAAc,CAAC,YAAY,CAAC;oBAChD,mCAAgB,CAAC,UAAU,EAC3B;oBACA,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBACpB,YAAY,GAAG,IAAI,CAAC;iBACrB;gBACD,qCAAqC;gBACrC,MAAM,gBAAgB,GAAG,GAAG,EAAE;oBAC5B,IAAI,YAAY,KAAK,KAAK,EAAE;wBAC1B,YAAY,GAAG,IAAI,CAAC;wBACpB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;qBACrB;gBACH,CAAC,CAAC;gBACF,4BAA4B;gBAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACnC,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC;gBACrE,MAAM,UAAU,GACd,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,cAAO,CAAC,IAAI;oBAChC,CAAC,CAAC,qBAAc,CACZ,aAAO,CAAC,MAAM,EAAE,EAChB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAC7C;oBACH,CAAC,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC;gBACvB,IAAI,WAAW,IAAI,CAAC,EAAE;oBACpB,SAAS,CAAC,WAAW,CAAC,GAAG;;wBACvB,IAAI,YAAY,KAAK,KAAK,EAAE;4BAC1B,YAAY,GAAG,IAAI,CAAC;4BACpB,MAAA,GAAG,CAAC,GAAG,0CAAE,cAAc,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;4BACpD,IAAI,CAAC,GAAG,EAAE,CAAC;yBACZ;wBACD,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,EAAE;4BAChD,GAAG,CAAC,8BAAsB,CAAc,CAAC,GAAG,EAAE,CAAC;yBACjD;wBACD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAa,CAAC;wBAC/C,OAAO,aAAO,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBACnE,CAAC,CAAC;iBACH;gBACD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAC/C;;;;;mBAKG;gBACH,IAAI,CAAC,YAAY,EAAE;oBACjB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;iBACtC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAtOD,wDAsOC"}

package/build/src/types.d.ts

@@ -0,0 +1,61 @@
+import { kLayerPatched } from './';
+import { Request } from 'express';
+import { SpanAttributes } from '@opentelemetry/api';
+import { InstrumentationConfig } from '@opentelemetry/instrumentation';
+import { ExpressLayerType } from './enums/ExpressLayerType';
+/**
+ * This const define where on the `request` object the Instrumentation will mount the
+ * current stack of express layer.
+ *
+ * It is necessary because express doesnt store the different layers
+ * (ie: middleware, router etc) that it called to get to the current layer.
+ * Given that, the only way to know the route of a given layer is to
+ * store the path of where each previous layer has been mounted.
+ *
+ * ex: bodyParser > auth middleware > /users router > get /:id
+ *  in this case the stack would be: ["/users", "/:id"]
+ *
+ * ex2: bodyParser > /api router > /v1 router > /users router > get /:id
+ *  stack: ["/api", "/v1", "/users", ":id"]
+ *
+ */
+export declare const _LAYERS_STORE_PROPERTY = "__ot_middlewares";
+export declare type PatchedRequest = {
+    [_LAYERS_STORE_PROPERTY]?: string[];
+} & Request;
+export declare type PathParams = string | RegExp | Array<string | RegExp>;
+export declare type ExpressRouter = {
+    params: {
+        [key: string]: string;
+    };
+    _params: string[];
+    caseSensitive: boolean;
+    mergeParams: boolean;
+    strict: boolean;
+    stack: ExpressLayer[];
+};
+export declare type ExpressLayer = {
+    handle: Function;
+    [kLayerPatched]?: boolean;
+    name: string;
+    params: {
+        [key: string]: string;
+    };
+    path: string;
+    regexp: RegExp;
+};
+export declare type LayerMetadata = {
+    attributes: SpanAttributes;
+    name: string;
+};
+export declare type IgnoreMatcher = string | RegExp | ((name: string) => boolean);
+/**
+ * Options available for the Express Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-Instrumentation-express#express-Instrumentation-options))
+ */
+export interface ExpressInstrumentationConfig extends InstrumentationConfig {
+    /** Ignore specific based on their name */
+    ignoreLayers?: IgnoreMatcher[];
+    /** Ignore specific layers based on their type */
+    ignoreLayersType?: ExpressLayerType[];
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/types.js

@@ -0,0 +1,37 @@
+"use strict";
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._LAYERS_STORE_PROPERTY = void 0;
+const _1 = require("./");
+/**
+ * This const define where on the `request` object the Instrumentation will mount the
+ * current stack of express layer.
+ *
+ * It is necessary because express doesnt store the different layers
+ * (ie: middleware, router etc) that it called to get to the current layer.
+ * Given that, the only way to know the route of a given layer is to
+ * store the path of where each previous layer has been mounted.
+ *
+ * ex: bodyParser > auth middleware > /users router > get /:id
+ *  in this case the stack would be: ["/users", "/:id"]
+ *
+ * ex2: bodyParser > /api router > /v1 router > /users router > get /:id
+ *  stack: ["/api", "/v1", "/users", ":id"]
+ *
+ */
+exports._LAYERS_STORE_PROPERTY = '__ot_middlewares';
+//# sourceMappingURL=types.js.map

package/build/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,yBAAmC;AAMnC;;;;;;;;;;;;;;;GAeG;AACU,QAAA,sBAAsB,GAAG,kBAAkB,CAAC"}

package/build/src/utils.d.ts

@@ -0,0 +1,28 @@
+import { SpanAttributes } from '@opentelemetry/api';
+import { ExpressLayer, PatchedRequest, ExpressInstrumentationConfig } from './types';
+import { ExpressLayerType } from './enums/ExpressLayerType';
+/**
+ * Store layers path in the request to be able to construct route later
+ * @param request The request where
+ * @param [value] the value to push into the array
+ */
+export declare const storeLayerPath: (request: PatchedRequest, value?: string | undefined) => void;
+/**
+ * Parse express layer context to retrieve a name and attributes.
+ * @param layer Express layer
+ * @param [layerPath] if present, the path on which the layer has been mounted
+ */
+export declare const getLayerMetadata: (layer: ExpressLayer, layerPath?: string | undefined) => {
+    attributes: SpanAttributes;
+    name: string;
+};
+/**
+ * Check whether the given request is ignored by configuration
+ * It will not re-throw exceptions from `list` provided by the client
+ * @param constant e.g URL of request
+ * @param [list] List of ignore patterns
+ * @param [onException] callback for doing something when an exception has
+ *     occurred
+ */
+export declare const isLayerIgnored: (name: string, type: ExpressLayerType, config?: ExpressInstrumentationConfig | undefined) => boolean;
+//# sourceMappingURL=utils.d.ts.map

package/build/src/utils.js

@@ -0,0 +1,123 @@
+"use strict";
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLayerIgnored = exports.getLayerMetadata = exports.storeLayerPath = void 0;
+const types_1 = require("./types");
+const ExpressLayerType_1 = require("./enums/ExpressLayerType");
+const AttributeNames_1 = require("./enums/AttributeNames");
+/**
+ * Store layers path in the request to be able to construct route later
+ * @param request The request where
+ * @param [value] the value to push into the array
+ */
+const storeLayerPath = (request, value) => {
+    if (Array.isArray(request[types_1._LAYERS_STORE_PROPERTY]) === false) {
+        Object.defineProperty(request, types_1._LAYERS_STORE_PROPERTY, {
+            enumerable: false,
+            value: [],
+        });
+    }
+    if (value === undefined)
+        return;
+    request[types_1._LAYERS_STORE_PROPERTY].push(value);
+};
+exports.storeLayerPath = storeLayerPath;
+/**
+ * Parse express layer context to retrieve a name and attributes.
+ * @param layer Express layer
+ * @param [layerPath] if present, the path on which the layer has been mounted
+ */
+const getLayerMetadata = (layer, layerPath) => {
+    if (layer.name === 'router') {
+        return {
+            attributes: {
+                [AttributeNames_1.AttributeNames.EXPRESS_NAME]: layerPath,
+                [AttributeNames_1.AttributeNames.EXPRESS_TYPE]: ExpressLayerType_1.ExpressLayerType.ROUTER,
+            },
+            name: `router - ${layerPath}`,
+        };
+    }
+    else if (layer.name === 'bound dispatch') {
+        return {
+            attributes: {
+                [AttributeNames_1.AttributeNames.EXPRESS_NAME]: layerPath !== null && layerPath !== void 0 ? layerPath : 'request handler',
+                [AttributeNames_1.AttributeNames.EXPRESS_TYPE]: ExpressLayerType_1.ExpressLayerType.REQUEST_HANDLER,
+            },
+            name: `request handler${layer.path ? ` - ${layerPath}` : ''}`,
+        };
+    }
+    else {
+        return {
+            attributes: {
+                [AttributeNames_1.AttributeNames.EXPRESS_NAME]: layer.name,
+                [AttributeNames_1.AttributeNames.EXPRESS_TYPE]: ExpressLayerType_1.ExpressLayerType.MIDDLEWARE,
+            },
+            name: `middleware - ${layer.name}`,
+        };
+    }
+};
+exports.getLayerMetadata = getLayerMetadata;
+/**
+ * Check whether the given obj match pattern
+ * @param constant e.g URL of request
+ * @param obj obj to inspect
+ * @param pattern Match pattern
+ */
+const satisfiesPattern = (constant, pattern) => {
+    if (typeof pattern === 'string') {
+        return pattern === constant;
+    }
+    else if (pattern instanceof RegExp) {
+        return pattern.test(constant);
+    }
+    else if (typeof pattern === 'function') {
+        return pattern(constant);
+    }
+    else {
+        throw new TypeError('Pattern is in unsupported datatype');
+    }
+};
+/**
+ * Check whether the given request is ignored by configuration
+ * It will not re-throw exceptions from `list` provided by the client
+ * @param constant e.g URL of request
+ * @param [list] List of ignore patterns
+ * @param [onException] callback for doing something when an exception has
+ *     occurred
+ */
+const isLayerIgnored = (name, type, config) => {
+    var _a;
+    if (Array.isArray(config === null || config === void 0 ? void 0 : config.ignoreLayersType) &&
+        ((_a = config === null || config === void 0 ? void 0 : config.ignoreLayersType) === null || _a === void 0 ? void 0 : _a.includes(type))) {
+        return true;
+    }
+    if (Array.isArray(config === null || config === void 0 ? void 0 : config.ignoreLayers) === false)
+        return false;
+    try {
+        for (const pattern of config.ignoreLayers) {
+            if (satisfiesPattern(name, pattern)) {
+                return true;
+            }
+        }
+    }
+    catch (e) {
+        /* catch block*/
+    }
+    return false;
+};
+exports.isLayerIgnored = isLayerIgnored;
+//# sourceMappingURL=utils.js.map

package/build/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,mCAMiB;AACjB,+DAA4D;AAC5D,2DAAwD;AAExD;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAAC,OAAuB,EAAE,KAAc,EAAE,EAAE;IACxE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,8BAAsB,CAAC,CAAC,KAAK,KAAK,EAAE;QAC5D,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,8BAAsB,EAAE;YACrD,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,EAAE;SACV,CAAC,CAAC;KACJ;IACD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAC/B,OAAO,CAAC,8BAAsB,CAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC,CAAC;AATW,QAAA,cAAc,kBASzB;AAEF;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAC9B,KAAmB,EACnB,SAAkB,EAIlB,EAAE;IACF,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC3B,OAAO;YACL,UAAU,EAAE;gBACV,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,SAAS;gBACxC,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,mCAAgB,CAAC,MAAM;aACvD;YACD,IAAI,EAAE,YAAY,SAAS,EAAE;SAC9B,CAAC;KACH;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE;QAC1C,OAAO;YACL,UAAU,EAAE;gBACV,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,iBAAiB;gBAC7D,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,mCAAgB,CAAC,eAAe;aAChE;YACD,IAAI,EAAE,kBAAkB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;SAC9D,CAAC;KACH;SAAM;QACL,OAAO;YACL,UAAU,EAAE;gBACV,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI;gBACzC,CAAC,+BAAc,CAAC,YAAY,CAAC,EAAE,mCAAgB,CAAC,UAAU;aAC3D;YACD,IAAI,EAAE,gBAAgB,KAAK,CAAC,IAAI,EAAE;SACnC,CAAC;KACH;AACH,CAAC,CAAC;AAhCW,QAAA,gBAAgB,oBAgC3B;AAEF;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CACvB,QAAgB,EAChB,OAAsB,EACb,EAAE;IACX,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,OAAO,KAAK,QAAQ,CAAC;KAC7B;SAAM,IAAI,OAAO,YAAY,MAAM,EAAE;QACpC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;KAC/B;SAAM,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QACxC,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;KAC1B;SAAM;QACL,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;KAC3D;AACH,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAC5B,IAAY,EACZ,IAAsB,EACtB,MAAqC,EAC5B,EAAE;;IACX,IACE,KAAK,CAAC,OAAO,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,CAAC;SACvC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,0CAAE,QAAQ,CAAC,IAAI,CAAC,CAAA,EACxC;QACA,OAAO,IAAI,CAAC;KACb;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,YAAY,CAAC,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IAChE,IAAI;QACF,KAAK,MAAM,OAAO,IAAI,MAAO,CAAC,YAAa,EAAE;YAC3C,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;gBACnC,OAAO,IAAI,CAAC;aACb;SACF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,gBAAgB;KACjB;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAvBW,QAAA,cAAc,kBAuBzB"}

package/build/src/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.25.0";
+//# sourceMappingURL=version.d.ts.map

package/build/src/version.js

@@ -0,0 +1,21 @@
+"use strict";
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+// this is autogenerated file, see scripts/version-update.js
+exports.VERSION = '0.25.0';
+//# sourceMappingURL=version.js.map

package/build/src/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@opentelemetry/instrumentation-express",
+  "version": "0.25.0",
+  "description": "OpenTelemetry express automatic instrumentation package.",
+  "main": "build/src/index.js",
+  "types": "build/src/index.d.ts",
+  "repository": "open-telemetry/opentelemetry-js-contrib",
+  "scripts": {
+    "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'",
+    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+    "tdd": "yarn test -- --watch-extensions ts --watch",
+    "clean": "rimraf build/*",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "precompile": "tsc --version",
+    "version:update": "node ../../../scripts/version-update.js",
+    "compile": "npm run version:update && tsc -p .",
+    "prepare": "npm run compile",
+    "watch": "tsc -w"
+  },
+  "keywords": [
+    "opentelemetry",
+    "express",
+    "nodejs",
+    "tracing",
+    "profiling",
+    "instrumentation"
+  ],
+  "author": "OpenTelemetry Authors",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=8.5.0"
+  },
+  "files": [
+    "build/src/**/*.js",
+    "build/src/**/*.js.map",
+    "build/src/**/*.d.ts",
+    "doc",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.0.2"
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "1.0.2",
+    "@opentelemetry/context-async-hooks": "0.25.0",
+    "@opentelemetry/sdk-trace-base": "0.25.0",
+    "@opentelemetry/sdk-trace-node": "0.25.0",
+    "@types/mocha": "7.0.2",
+    "@types/node": "14.17.9",
+    "codecov": "3.8.3",
+    "express": "4.17.1",
+    "gts": "3.1.0",
+    "mocha": "7.2.0",
+    "nyc": "15.1.0",
+    "rimraf": "3.0.2",
+    "ts-mocha": "8.0.0",
+    "typescript": "4.3.5"
+  },
+  "dependencies": {
+    "@opentelemetry/core": "^0.25.0",
+    "@opentelemetry/instrumentation": "^0.25.0",
+    "@opentelemetry/semantic-conventions": "^0.25.0",
+    "@types/express": "4.17.13"
+  },
+  "gitHead": "fcfaeb965804d2a081f1dc8d2b82803cd51681af"
+}