diff --git a/plugins/node/opentelemetry-instrumentation-knex/.eslintignore b/plugins/node/opentelemetry-instrumentation-knex/.eslintignore
new file mode 100644
index 0000000000..378eac25d3
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/plugins/node/opentelemetry-instrumentation-knex/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-knex/.eslintrc.js
new file mode 100644
index 0000000000..f756f4488b
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+ "env": {
+ "mocha": true,
+ "node": true
+ },
+ ...require('../../../eslint.config.js')
+}
diff --git a/plugins/node/opentelemetry-instrumentation-knex/.npmignore b/plugins/node/opentelemetry-instrumentation-knex/.npmignore
new file mode 100644
index 0000000000..9505ba9450
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/.npmignore
@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test
diff --git a/plugins/node/opentelemetry-instrumentation-knex/LICENSE b/plugins/node/opentelemetry-instrumentation-knex/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/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.
diff --git a/plugins/node/opentelemetry-instrumentation-knex/README.md b/plugins/node/opentelemetry-instrumentation-knex/README.md
new file mode 100644
index 0000000000..e0b65e9160
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/README.md
@@ -0,0 +1,71 @@
+# OpenTelemetry Knex 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 [`knex`](https://github.com/knex/node-knex) and allows the user to automatically collect trace data and export them to their backend of choice.
+
+For automatic instrumentation see the
+[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
+
+## Installation
+
+```bash
+npm install --save @opentelemetry/instrumentation-knex
+```
+
+### Supported Versions
+
+ - `>=0.10.0`
+
+## Usage
+
+```js
+const { KnexInstrumentation, KnexInstrumentationConfig } = require('@opentelemetry/instrumentation-knex');
+const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+const provider = new NodeTracerProvider();
+
+provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+provider.register();
+
+registerInstrumentations({
+ instrumentations: [
+ new KnexInstrumentation(
+ new KnexInstrumentationConfig({
+ maxQueryLength: 100,
+ })
+ )],
+ tracerProvider: provider,
+});
+```
+
+### Configuration Options
+
+| Options | Type | Example | Description |
+| ------- | ---- | ------- | ----------- |
+| `maxQueryLength` | `number` | `100` | Truncate `db.statement` attribute to a maximum length. If the statement is truncated `'..'` is added to it's end. Default `1022`. `-1` leaves `db.statement` untouched. |
+
+## Useful links
+
+- For more information on OpenTelemetry, visit:
+- For more about OpenTelemetry JavaScript:
+- 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://david-dm.org/open-telemetry/opentelemetry-js-contrib/status.svg?path=packages/opentelemetry-instrumentation-knex
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-instrumentation-knex
+[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/dev-status.svg?path=packages/opentelemetry-instrumentation-knex
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-instrumentation-knex&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-knex
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-knex.svg
diff --git a/plugins/node/opentelemetry-instrumentation-knex/package.json b/plugins/node/opentelemetry-instrumentation-knex/package.json
new file mode 100644
index 0000000000..5c16f51abe
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/package.json
@@ -0,0 +1,67 @@
+{
+ "name": "@opentelemetry/instrumentation-knex",
+ "version": "0.16.0",
+ "description": "OpenTelemetry Knex 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",
+ "knex",
+ "nodejs",
+ "tracing",
+ "instrumentation"
+ ],
+ "author": "OpenTelemetry Authors",
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=8.5.0"
+ },
+ "files": [
+ "build/src/**/*.js",
+ "build/src/**/*.d.ts",
+ "doc",
+ "LICENSE",
+ "README.md"
+ ],
+ "publishConfig": {
+ "access": "public"
+ },
+ "peerDependencies": {
+ "@opentelemetry/api": "^0.20.0"
+ },
+ "devDependencies": {
+ "@opentelemetry/api": "0.20.0",
+ "@opentelemetry/context-async-hooks": "0.20.0",
+ "@opentelemetry/node": "0.20.0",
+ "@opentelemetry/tracing": "0.20.0",
+ "@types/mocha": "7.0.2",
+ "@types/node": "14.0.27",
+ "codecov": "3.7.2",
+ "gts": "3.1.0",
+ "knex": "^0.95.6",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "3.0.2",
+ "sqlite3": "^5.0.2",
+ "ts-mocha": "8.0.0",
+ "typescript": "4.1.3"
+ },
+ "dependencies": {
+ "@opentelemetry/instrumentation": "^0.20.0",
+ "@opentelemetry/semantic-conventions": "^0.20.0"
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/constants.ts b/plugins/node/opentelemetry-instrumentation-knex/src/constants.ts
new file mode 100644
index 0000000000..dfb011cd45
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/constants.ts
@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+export const MODULE_NAME = 'knex';
+export const SUPPORTED_VERSIONS = [
+ // use "lib/execution" for runner.js, "lib" for client.js as basepath, latest tested 0.95.6
+ '>=0.22.0',
+ // use "lib" as basepath
+ '>=0.10.0 <0.18.0',
+ '>=0.19.0 <0.22.0',
+ // use "src" as basepath
+ '>=0.18.0 <0.19.0',
+];
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/index.ts b/plugins/node/opentelemetry-instrumentation-knex/src/index.ts
new file mode 100644
index 0000000000..500f2675e4
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/index.ts
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+import { KnexInstrumentation } from './instrumentation';
+
+export * from './instrumentation';
+export default KnexInstrumentation;
+
+export { KnexInstrumentationConfig } from './types';
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts
new file mode 100644
index 0000000000..c801d6136b
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts
@@ -0,0 +1,223 @@
+/*
+ * 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.
+ */
+
+import * as api from '@opentelemetry/api';
+import { VERSION } from './version';
+import * as constants from './constants';
+import {
+ InstrumentationBase,
+ InstrumentationNodeModuleDefinition,
+ InstrumentationNodeModuleFile,
+ isWrapped,
+} from '@opentelemetry/instrumentation';
+import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import * as utils from './utils';
+import * as types from './types';
+
+import type * as knex from 'knex';
+
+const contextSymbol = Symbol('opentelemetry.instrumentation-knex.context');
+const DEFAULT_CONFIG: types.KnexInstrumentationConfig = {
+ maxQueryLength: 1022,
+};
+
+export class KnexInstrumentation extends InstrumentationBase {
+ constructor(config: types.KnexInstrumentationConfig = {}) {
+ super(
+ `@opentelemetry/instrumentation-${constants.MODULE_NAME}`,
+ VERSION,
+ Object.assign({}, DEFAULT_CONFIG, config)
+ );
+ }
+
+ init() {
+ const module = new InstrumentationNodeModuleDefinition(
+ constants.MODULE_NAME,
+ constants.SUPPORTED_VERSIONS
+ );
+
+ module.files.push(
+ this.getClientNodeModuleFileInstrumentation('src'),
+ this.getClientNodeModuleFileInstrumentation('lib'),
+ this.getRunnerNodeModuleFileInstrumentation('src'),
+ this.getRunnerNodeModuleFileInstrumentation('lib'),
+ this.getRunnerNodeModuleFileInstrumentation('lib/execution')
+ );
+
+ return module;
+ }
+
+ private getRunnerNodeModuleFileInstrumentation(basePath: string) {
+ return new InstrumentationNodeModuleFile(
+ `knex/${basePath}/runner.js`,
+ constants.SUPPORTED_VERSIONS,
+ (Runner: any, moduleVersion) => {
+ api.diag.debug(
+ `Applying ${basePath}/runner.js patch for ${constants.MODULE_NAME}@${moduleVersion}`
+ );
+ this.ensureWrapped(
+ moduleVersion,
+ Runner.prototype,
+ 'query',
+ this.createQueryWrapper(moduleVersion)
+ );
+ return Runner;
+ },
+ (Runner: any, moduleVersion) => {
+ api.diag.debug(
+ `Removing ${basePath}/runner.js patch for ${constants.MODULE_NAME}@${moduleVersion}`
+ );
+ this._unwrap(Runner.prototype, 'query');
+ return Runner;
+ }
+ );
+ }
+
+ private getClientNodeModuleFileInstrumentation(basePath: string) {
+ return new InstrumentationNodeModuleFile(
+ `knex/${basePath}/client.js`,
+ constants.SUPPORTED_VERSIONS,
+ (Client: any, moduleVersion) => {
+ api.diag.debug(
+ `Applying ${basePath}/client.js patch for ${constants.MODULE_NAME}@${moduleVersion}`
+ );
+ this.ensureWrapped(
+ moduleVersion,
+ Client.prototype,
+ 'queryBuilder',
+ this.storeContext.bind(this)
+ );
+ this.ensureWrapped(
+ moduleVersion,
+ Client.prototype,
+ 'schemaBuilder',
+ this.storeContext.bind(this)
+ );
+ this.ensureWrapped(
+ moduleVersion,
+ Client.prototype,
+ 'raw',
+ this.storeContext.bind(this)
+ );
+ return Client;
+ },
+ (Client: any, moduleVersion) => {
+ api.diag.debug(
+ `Removing ${basePath}/client.js patch for ${constants.MODULE_NAME}@${moduleVersion}`
+ );
+ this._unwrap(Client.prototype, 'queryBuilder');
+ this._unwrap(Client.prototype, 'schemaBuilder');
+ this._unwrap(Client.prototype, 'raw');
+ return Client;
+ }
+ );
+ }
+
+ private createQueryWrapper(moduleVersion?: string) {
+ const instrumentation = this;
+ return function wrapQuery(original: () => any) {
+ return function wrapped_logging_method(this: any, query: any) {
+ const config = this.client.config;
+
+ const table = this.builder?._single?.table;
+ // `method` actually refers to the knex API method - Not exactly "operation"
+ // in the spec sense, but matches most of the time.
+ const operation = query?.method;
+ const name =
+ config?.connection?.filename || config?.connection?.database;
+ const maxLen = (
+ instrumentation._config as types.KnexInstrumentationConfig
+ ).maxQueryLength!;
+
+ const attributes: api.SpanAttributes = {
+ 'knex.version': moduleVersion,
+ [SemanticAttributes.DB_SYSTEM]: utils.mapSystem(config.client),
+ [SemanticAttributes.DB_SQL_TABLE]: table,
+ [SemanticAttributes.DB_OPERATION]: operation,
+ [SemanticAttributes.DB_USER]: config?.connection?.user,
+ [SemanticAttributes.DB_NAME]: name,
+ [SemanticAttributes.NET_PEER_NAME]: config?.connection?.host,
+ [SemanticAttributes.NET_PEER_PORT]: config?.connection?.port,
+ [SemanticAttributes.NET_TRANSPORT]:
+ config?.connection?.filename === ':memory:' ? 'inproc' : undefined,
+ };
+ if (maxLen !== 0) {
+ attributes[SemanticAttributes.DB_STATEMENT] = utils.limitLength(
+ query?.sql,
+ maxLen
+ );
+ }
+
+ const parent = this.builder[contextSymbol];
+ const span = instrumentation.tracer.startSpan(
+ utils.getName(name, operation, table),
+ {
+ attributes,
+ },
+ parent
+ );
+ const spanContext = api.trace.setSpan(api.context.active(), span);
+
+ return api.context
+ .with(spanContext, original, this, ...arguments)
+ .then((result: unknown) => {
+ span.end();
+ return result;
+ })
+ .catch((err: any) => {
+ // knex adds full query with all the binding values to the message,
+ // we want to undo that without changing the original error
+ const formatter = utils.getFormatter(this);
+ const fullQuery = formatter(query.sql, query.bindings || []);
+ const message = err.message.replace(fullQuery + ' - ', '');
+ const clonedError = utils.cloneErrorWithNewMessage(err, message);
+ span.recordException(clonedError);
+ span.setStatus({ code: api.SpanStatusCode.ERROR, message });
+ span.end();
+ throw err;
+ });
+ };
+ };
+ }
+
+ private storeContext(original: Function) {
+ return function wrapped_logging_method(this: any) {
+ const builder = original.apply(this, arguments);
+ // Builder is a custom promise type and when awaited it fails to propagate context.
+ // We store the parent context at the moment of initiating the builder
+ // otherwise we'd have nothing to attach the span as a child for in `query`.
+ Object.defineProperty(builder, contextSymbol, {
+ value: api.context.active(),
+ });
+ return builder;
+ };
+ }
+
+ ensureWrapped(
+ moduleVersion: string | undefined,
+ obj: any,
+ methodName: string,
+ wrapper: (original: any) => any
+ ) {
+ api.diag.debug(
+ `Applying ${methodName} patch for ${constants.MODULE_NAME}@${moduleVersion}`
+ );
+ if (isWrapped(obj[methodName])) {
+ this._unwrap(obj, methodName);
+ }
+ this._wrap(obj, methodName, wrapper);
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/types.ts b/plugins/node/opentelemetry-instrumentation-knex/src/types.ts
new file mode 100644
index 0000000000..a952a66e3d
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/types.ts
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+import { InstrumentationConfig } from '@opentelemetry/instrumentation';
+
+export interface KnexInstrumentationConfig extends InstrumentationConfig {
+ /** max query length in db.statement attribute ".." is added to the end when query is truncated */
+ maxQueryLength?: number;
+}
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/utils.ts b/plugins/node/opentelemetry-instrumentation-knex/src/utils.ts
new file mode 100644
index 0000000000..ec8c9bdb5d
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/utils.ts
@@ -0,0 +1,80 @@
+/*
+ * 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.
+ */
+
+type Exception = {
+ new (message: string): Exception;
+ constructor: Exception;
+ errno?: number;
+ code?: string;
+ stack?: string;
+};
+
+export const getFormatter = (runner: any) => {
+ if (runner) {
+ if (runner.client) {
+ if (runner.client._formatQuery) {
+ return runner.client._formatQuery.bind(runner.client);
+ } else if (runner.client.SqlString) {
+ return runner.client.SqlString.format.bind(runner.client.SqlString);
+ }
+ }
+ if (runner.builder) {
+ return runner.builder.toString.bind(runner.builder);
+ }
+ }
+ return () => '';
+};
+
+export const cloneErrorWithNewMessage = (err: Exception, message: string) => {
+ if (err && err instanceof Error) {
+ const clonedError = new (err.constructor as Exception)(message);
+ clonedError.code = err.code;
+ clonedError.stack = err.stack;
+ clonedError.errno = err.errno;
+ return clonedError;
+ }
+ return err;
+};
+
+const systemMap = new Map([
+ ['sqlite3', 'sqlite'],
+ ['pg', 'postgresql'],
+]);
+export const mapSystem = (knexSystem: string) => {
+ return systemMap.get(knexSystem) || knexSystem;
+};
+
+export const getName = (db: string, operation?: string, table?: string) => {
+ if (operation) {
+ if (table) {
+ return `${operation} ${db}.${table}`;
+ }
+ return `${operation} ${db}`;
+ }
+ return db;
+};
+
+export const limitLength = (str: string, maxLength: number) => {
+ if (
+ typeof str === 'string' &&
+ typeof maxLength === 'number' &&
+ 0 < maxLength &&
+ maxLength < str.length
+ ) {
+ return str.substr(0, maxLength) + '..';
+ }
+ return str;
+};
diff --git a/plugins/node/opentelemetry-instrumentation-knex/src/version.ts b/plugins/node/opentelemetry-instrumentation-knex/src/version.ts
new file mode 100644
index 0000000000..eacb17da85
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/src/version.ts
@@ -0,0 +1,18 @@
+/*
+ * 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.
+ */
+
+// this is autogenerated file, see scripts/version-update.js
+export const VERSION = '0.16.0';
diff --git a/plugins/node/opentelemetry-instrumentation-knex/test/index.test.ts b/plugins/node/opentelemetry-instrumentation-knex/test/index.test.ts
new file mode 100644
index 0000000000..ed41c012de
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/test/index.test.ts
@@ -0,0 +1,258 @@
+/*
+ * 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.
+ */
+
+import { context, trace } from '@opentelemetry/api';
+import { NodeTracerProvider } from '@opentelemetry/node';
+import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
+import {
+ InMemorySpanExporter,
+ SimpleSpanProcessor,
+} from '@opentelemetry/tracing';
+import * as assert from 'assert';
+
+import Instrumentation from '../src';
+const plugin = new Instrumentation({
+ maxQueryLength: 50,
+});
+
+import knex from 'knex';
+
+describe('Knex instrumentation', () => {
+ const provider = new NodeTracerProvider();
+ const memoryExporter = new InMemorySpanExporter();
+ const spanProcessor = new SimpleSpanProcessor(memoryExporter);
+ provider.addSpanProcessor(spanProcessor);
+ plugin.setTracerProvider(provider);
+ const tracer = provider.getTracer('default');
+ let contextManager: AsyncHooksContextManager;
+ let client: any;
+
+ before(() => {
+ plugin.enable();
+ });
+
+ after(() => {
+ plugin.disable();
+ });
+
+ beforeEach(async () => {
+ contextManager = new AsyncHooksContextManager();
+ context.setGlobalContextManager(contextManager.enable());
+
+ client = knex({
+ client: 'sqlite3',
+ connection: {
+ filename: ':memory:',
+ },
+ useNullAsDefault: true,
+ });
+
+ assert.strictEqual(memoryExporter.getFinishedSpans().length, 0);
+ });
+
+ afterEach(() => {
+ memoryExporter.reset();
+ context.disable();
+ client.schema.dropTableIfExists('testTable');
+ client.schema.dropTableIfExists('testTable1');
+ client.schema.dropTableIfExists('testTable2');
+ client.destroy();
+ });
+
+ describe('Instrumenting', () => {
+ it('should record spans from query builder', async () => {
+ const parentSpan = tracer.startSpan('parentSpan');
+ await context.with(
+ trace.setSpan(context.active(), parentSpan),
+ async () => {
+ await client.schema.createTable('testTable1', (table: any) => {
+ table.string('title');
+ });
+ await client.insert({ title: 'test1' }).into('testTable1');
+
+ assert.deepEqual(await client('testTable1').select('*'), [
+ { title: 'test1' },
+ ]);
+
+ parentSpan.end();
+
+ const instrumentationSpans = memoryExporter.getFinishedSpans();
+ const last = instrumentationSpans.pop() as any;
+ assertSpans(instrumentationSpans, [
+ {
+ statement: 'create table `testTable1` (`title` varchar(255))',
+ parentSpan,
+ },
+ {
+ op: 'insert',
+ table: 'testTable1',
+ statement: 'insert into `testTable1` (`title`) values (?)',
+ parentSpan,
+ },
+ {
+ op: 'select',
+ table: 'testTable1',
+ statement: 'select * from `testTable1`',
+ parentSpan,
+ },
+ ]);
+ assert.strictEqual(instrumentationSpans[0].name, ':memory:');
+ assert.strictEqual(
+ instrumentationSpans[1].name,
+ 'insert :memory:.testTable1'
+ );
+
+ assert(last.name, 'parentSpan');
+ }
+ );
+ });
+
+ it('should collect spans from raw', async () => {
+ const parentSpan = tracer.startSpan('parentSpan');
+ const statement = "select date('now')";
+
+ await context.with(
+ trace.setSpan(context.active(), parentSpan),
+ async () => {
+ await client.raw(statement);
+ parentSpan.end();
+
+ assertSpans(memoryExporter.getFinishedSpans(), [
+ { statement, op: 'raw', parentSpan },
+ null,
+ ]);
+ }
+ );
+ });
+
+ it('should truncate the query', async () => {
+ const statement = `select date('now'), "${'long-'.repeat(15)}"`;
+ await client.raw(statement);
+
+ const [span] = memoryExporter.getFinishedSpans();
+ const limitedStatement = span?.attributes?.['db.statement'] as string;
+ assert.strictEqual(limitedStatement.length, 52);
+ assert.ok(statement.startsWith(limitedStatement.substr(0, 50)));
+ });
+
+ it('should catch errors', async () => {
+ const parentSpan = tracer.startSpan('parentSpan');
+ const neverError = new Error('Query was expected to error');
+ const MESSAGE = 'SQLITE_ERROR: no such table: testTable1';
+ const CODE = 'SQLITE_ERROR';
+
+ await context.with(
+ trace.setSpan(context.active(), parentSpan),
+ async () => {
+ await client
+ .insert({ title: 'test1' })
+ .into('testTable1')
+ .then(() => {
+ throw neverError;
+ })
+ .catch((err: any) => {
+ assertMatch(err.message, /SQLITE_ERROR/, err);
+ });
+ parentSpan.end();
+
+ const events = memoryExporter.getFinishedSpans()[0].events!;
+
+ assert.strictEqual(events.length, 1);
+ assert.strictEqual(events[0].name, 'exception');
+ assert.strictEqual(
+ events[0].attributes?.['exception.message'],
+ MESSAGE
+ );
+ assert.strictEqual(events[0].attributes?.['exception.type'], CODE);
+
+ assertSpans(memoryExporter.getFinishedSpans(), [
+ {
+ op: 'insert',
+ table: 'testTable1',
+ statement: 'insert into `testTable1` (`title`) values (?)',
+ parentSpan,
+ },
+ null,
+ ]);
+ }
+ );
+ });
+ });
+
+ describe('Disabling instrumentation', () => {
+ it('should not create new spans', async () => {
+ plugin.disable();
+ const parentSpan = tracer.startSpan('parentSpan');
+
+ await context.with(
+ trace.setSpan(context.active(), parentSpan),
+ async () => {
+ await client.raw("select date('now')");
+ parentSpan.end();
+ assert.strictEqual(memoryExporter.getFinishedSpans().length, 1);
+ assert.notStrictEqual(
+ memoryExporter.getFinishedSpans()[0],
+ undefined
+ );
+ }
+ );
+ });
+ });
+});
+
+const assertSpans = (actualSpans: any[], expectedSpans: any[]) => {
+ assert(Array.isArray(actualSpans), 'Expected `actualSpans` to be an array');
+ assert(
+ Array.isArray(expectedSpans),
+ 'Expected `expectedSpans` to be an array'
+ );
+ assert.strictEqual(
+ actualSpans.length,
+ expectedSpans.length,
+ 'Expected span count different from actual'
+ );
+ actualSpans.forEach((span, idx) => {
+ const expected = expectedSpans[idx];
+ if (expected === null) return;
+ try {
+ assert.notStrictEqual(span, undefined);
+ assert.notStrictEqual(expected, undefined);
+ assertMatch(span.name, new RegExp(expected.op));
+ assertMatch(span.name, new RegExp(':memory:'));
+ assert.strictEqual(span.attributes['db.system'], 'sqlite');
+ assert.strictEqual(span.attributes['db.name'], ':memory:');
+ assert.strictEqual(span.attributes['db.sql.table'], expected.table);
+ assert.strictEqual(span.attributes['db.statement'], expected.statement);
+ assert.strictEqual(
+ typeof span.attributes['knex.version'],
+ 'string',
+ 'knex.version not specified'
+ );
+ assert.strictEqual(span.attributes['db.operation'], expected.op);
+ assert.strictEqual(
+ span.parentSpanId,
+ expected.parentSpan?.spanContext().spanId
+ );
+ } catch (e) {
+ e.message = `At span[${idx}]: ${e.message}`;
+ throw e;
+ }
+ });
+};
+
+const assertMatch = (str: string, regexp: RegExp, err?: any) => {
+ assert.ok(regexp.test(str), err ?? `Expected '${str} to match ${regexp}`);
+};
diff --git a/plugins/node/opentelemetry-instrumentation-knex/tsconfig.json b/plugins/node/opentelemetry-instrumentation-knex/tsconfig.json
new file mode 100644
index 0000000000..28be80d266
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-knex/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}