diff --git a/plugins/node/opentelemetry-instrumentation-mysql/test/mysql.test.ts b/plugins/node/opentelemetry-instrumentation-mysql/test/index.test.ts
similarity index 100%
rename from plugins/node/opentelemetry-instrumentation-mysql/test/mysql.test.ts
rename to plugins/node/opentelemetry-instrumentation-mysql/test/index.test.ts
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/.eslintignore b/plugins/node/opentelemetry-instrumentation-mysql2/.eslintignore
new file mode 100644
index 0000000000..378eac25d3
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-mysql2/.eslintrc.js
new file mode 100644
index 0000000000..f756f4488b
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+ "env": {
+ "mocha": true,
+ "node": true
+ },
+ ...require('../../../eslint.config.js')
+}
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/.npmignore b/plugins/node/opentelemetry-instrumentation-mysql2/.npmignore
new file mode 100644
index 0000000000..9505ba9450
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/.npmignore
@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/LICENSE b/plugins/node/opentelemetry-instrumentation-mysql2/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/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-mysql2/README.md b/plugins/node/opentelemetry-instrumentation-mysql2/README.md
new file mode 100644
index 0000000000..dfb651c0ea
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/README.md
@@ -0,0 +1,62 @@
+# OpenTelemetry mysql 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 [`mysql2`](https://github.com/sidorares/node-mysql2).
+
+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-mysql2
+```
+
+## Supported Versions
+
+- `2.x`
+
+## Usage
+
+OpenTelemetry MySQL2 Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with [mysql2](https://github.com/sidorares/node-mysql2).
+
+To load a specific plugin (**MySQL2** in this case), specify it in the registerInstrumentations's configuration
+
+```js
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { MySQL2Instrumentation } = require('@opentelemetry/instrumentation-mysql2');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+const provider = new NodeTracerProvider();
+provider.register();
+
+registerInstrumentations({
+ instrumentations: [
+ new MySQL2Instrumentation(),
+ ],
+})
+```
+
+## 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://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-mysql2
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-mysql2
+[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-mysql2&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-mysql2&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-mysql2
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-mysql2.svg
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/env b/plugins/node/opentelemetry-instrumentation-mysql2/env
new file mode 100644
index 0000000000..d48d83fded
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/env
@@ -0,0 +1,5 @@
+export MYSQL_DATABASE=circle_database
+export MYSQL_HOST=mysql
+export MYSQL_PASSWORD=secret
+export MYSQL_PORT=3306
+export MYSQL_USER=otel
\ No newline at end of file
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/package.json b/plugins/node/opentelemetry-instrumentation-mysql2/package.json
new file mode 100644
index 0000000000..2c35d0a0e5
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/package.json
@@ -0,0 +1,67 @@
+{
+ "name": "@opentelemetry/instrumentation-mysql2",
+ "version": "0.20.0",
+ "description": "OpenTelemetry mysql2 automatic instrumentation package.",
+ "main": "build/src/index.js",
+ "types": "build/src/index.d.ts",
+ "repository": "open-telemetry/opentelemetry-js-contrib",
+ "scripts": {
+ "clean": "rimraf build/*",
+ "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+ "compile": "npm run version:update && tsc -p .",
+ "lint:fix": "eslint . --ext .ts --fix",
+ "lint": "eslint . --ext .ts",
+ "precompile": "tsc --version",
+ "prepare": "npm run compile",
+ "tdd": "npm run test -- --watch-extensions ts --watch",
+ "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
+ "version:update": "node ../../../scripts/version-update.js"
+ },
+ "keywords": [
+ "opentelemetry",
+ "mysql",
+ "mysql2",
+ "nodejs",
+ "tracing",
+ "profiling",
+ "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/test-utils": "0.20.0",
+ "@opentelemetry/tracing": "0.20.0",
+ "@types/mocha": "7.0.2",
+ "@types/node": "14.17.0",
+ "codecov": "3.8.2",
+ "gts": "3.1.0",
+ "mocha": "7.2.0",
+ "mysql2": "^2.2.5",
+ "nyc": "15.1.0",
+ "rimraf": "3.0.2",
+ "ts-mocha": "8.0.0",
+ "typescript": "4.2.4"
+ },
+ "dependencies": {
+ "@opentelemetry/instrumentation": "^0.20.0",
+ "@opentelemetry/semantic-conventions": "^0.20.0"
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/src/index.ts b/plugins/node/opentelemetry-instrumentation-mysql2/src/index.ts
new file mode 100644
index 0000000000..a6a38a3c70
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/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 { MySQL2Instrumentation } from './instrumentation';
+
+export * from './instrumentation';
+export default MySQL2Instrumentation;
+
+export { MySQL2InstrumentationConfig } from './types';
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-mysql2/src/instrumentation.ts
new file mode 100644
index 0000000000..3a5fcd5f04
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/src/instrumentation.ts
@@ -0,0 +1,177 @@
+/*
+ * 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 {
+ InstrumentationBase,
+ InstrumentationNodeModuleDefinition,
+ isWrapped,
+} from '@opentelemetry/instrumentation';
+import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import type * as mysqlTypes from 'mysql2';
+import { MySQL2InstrumentationConfig } from './types';
+import {
+ getConnectionAttributes,
+ getDbStatement,
+ getSpanName,
+ once,
+} from './utils';
+import { VERSION } from './version';
+
+type formatType = typeof mysqlTypes.format;
+
+export class MySQL2Instrumentation extends InstrumentationBase<
+ typeof mysqlTypes
+> {
+ static readonly COMPONENT = 'mysql';
+ static readonly COMMON_ATTRIBUTES = {
+ [SemanticAttributes.DB_SYSTEM]: MySQL2Instrumentation.COMPONENT,
+ };
+
+ constructor(protected _config: MySQL2InstrumentationConfig = {}) {
+ super('@opentelemetry/instrumentation-mysql2', VERSION, _config);
+ }
+
+ protected init() {
+ return [
+ new InstrumentationNodeModuleDefinition(
+ 'mysql2',
+ ['2.*'],
+ (moduleExports: any, moduleVersion) => {
+ api.diag.debug(`Patching mysql@${moduleVersion}`);
+
+ const ConnectionPrototype: mysqlTypes.Connection =
+ moduleExports.Connection.prototype;
+ api.diag.debug('Patching Connection.prototype.query');
+ if (isWrapped(ConnectionPrototype.query)) {
+ this._unwrap(ConnectionPrototype, 'query');
+ }
+ this._wrap(
+ ConnectionPrototype,
+ 'query',
+ this._patchQuery(moduleExports.format) as any
+ );
+
+ return moduleExports;
+ },
+ (moduleExports: any) => {
+ if (moduleExports === undefined) return;
+ const ConnectionPrototype: mysqlTypes.Connection =
+ moduleExports.Connection.prototype;
+ this._unwrap(ConnectionPrototype, 'query');
+ }
+ ),
+ ];
+ }
+
+ private _patchQuery(format: formatType) {
+ return (originalQuery: Function): Function => {
+ const thisPlugin = this;
+ api.diag.debug('MySQL2Instrumentation: patched mysql query');
+
+ return function query(
+ this: mysqlTypes.Connection,
+ query: string | mysqlTypes.Query | mysqlTypes.QueryOptions,
+ _valuesOrCallback?: unknown[] | Function,
+ _callback?: Function
+ ) {
+ let values;
+ if (Array.isArray(_valuesOrCallback)) {
+ values = _valuesOrCallback;
+ } else if (arguments[2]) {
+ values = [_valuesOrCallback];
+ }
+
+ const span = thisPlugin.tracer.startSpan(getSpanName(query), {
+ kind: api.SpanKind.CLIENT,
+ attributes: {
+ ...MySQL2Instrumentation.COMMON_ATTRIBUTES,
+ ...getConnectionAttributes(this.config),
+ [SemanticAttributes.DB_STATEMENT]: getDbStatement(
+ query,
+ format,
+ values
+ ),
+ },
+ });
+ const endSpan = once((err?: any) => {
+ if (err) {
+ span.setStatus({
+ code: api.SpanStatusCode.ERROR,
+ message: err.message,
+ });
+ }
+ span.end();
+ });
+
+ if (arguments.length === 1) {
+ if (typeof (query as any).onResult === 'function') {
+ thisPlugin._wrap(
+ query as any,
+ 'onResult',
+ thisPlugin._patchCallbackQuery(endSpan)
+ );
+ }
+
+ const streamableQuery: mysqlTypes.Query = originalQuery.apply(
+ this,
+ arguments
+ );
+
+ // `end` in mysql behaves similarly to `result` in mysql2.
+ streamableQuery
+ .once('error', err => {
+ endSpan(err);
+ })
+ .once('result', () => {
+ endSpan();
+ });
+
+ return streamableQuery;
+ }
+
+ if (typeof arguments[1] === 'function') {
+ thisPlugin._wrap(
+ arguments,
+ 1,
+ thisPlugin._patchCallbackQuery(endSpan)
+ );
+ } else if (typeof arguments[2] === 'function') {
+ thisPlugin._wrap(
+ arguments,
+ 2,
+ thisPlugin._patchCallbackQuery(endSpan)
+ );
+ }
+
+ return originalQuery.apply(this, arguments);
+ };
+ };
+ }
+
+ private _patchCallbackQuery(endSpan: Function) {
+ return (originalCallback: Function) => {
+ return function (
+ err: mysqlTypes.QueryError | null,
+ results?: any,
+ fields?: mysqlTypes.FieldPacket[]
+ ) {
+ endSpan(err);
+ return originalCallback(...arguments);
+ };
+ };
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/src/types.ts b/plugins/node/opentelemetry-instrumentation-mysql2/src/types.ts
new file mode 100644
index 0000000000..16df8a745e
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/src/types.ts
@@ -0,0 +1,19 @@
+/*
+ * 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 type MySQL2InstrumentationConfig = InstrumentationConfig;
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/src/utils.ts b/plugins/node/opentelemetry-instrumentation-mysql2/src/utils.ts
new file mode 100644
index 0000000000..b6ab662be2
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/src/utils.ts
@@ -0,0 +1,115 @@
+/*
+ * 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 { SpanAttributes } from '@opentelemetry/api';
+import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import type { Query, QueryOptions } from 'mysql2';
+
+interface Config {
+ host?: string;
+ port?: number;
+ database?: string;
+ user?: string;
+ connectionConfig?: Config;
+}
+/**
+ * Get an SpanAttributes map from a mysql connection config object
+ *
+ * @param config ConnectionConfig
+ */
+export function getConnectionAttributes(config: Config): SpanAttributes {
+ const { host, port, database, user } = getConfig(config);
+
+ return {
+ [SemanticAttributes.NET_PEER_NAME]: host,
+ [SemanticAttributes.NET_PEER_PORT]: port,
+ [SemanticAttributes.NET_PEER_IP]: getJDBCString(host, port, database),
+ [SemanticAttributes.DB_NAME]: database,
+ [SemanticAttributes.DB_USER]: user,
+ };
+}
+
+function getConfig(config: any) {
+ const { host, port, database, user } =
+ (config && config.connectionConfig) || config || {};
+ return { host, port, database, user };
+}
+
+function getJDBCString(
+ host: string | undefined,
+ port: number | undefined,
+ database: string | undefined
+) {
+ let jdbcString = `jdbc:mysql://${host || 'localhost'}`;
+
+ if (typeof port === 'number') {
+ jdbcString += `:${port}`;
+ }
+
+ if (typeof database === 'string') {
+ jdbcString += `/${database}`;
+ }
+
+ return jdbcString;
+}
+
+/**
+ * Conjures up the value for the db.statement attribute by formatting a SQL query.
+ *
+ * @returns the database statement being executed.
+ */
+export function getDbStatement(
+ query: string | Query | QueryOptions,
+ format: (
+ sql: string,
+ values: any[],
+ stringifyObjects?: boolean,
+ timeZone?: string
+ ) => string,
+ values?: any[]
+): string {
+ if (typeof query === 'string') {
+ return values ? format(query, values) : query;
+ } else {
+ // According to https://github.com/mysqljs/mysql#performing-queries
+ // The values argument will override the values in the option object.
+ return values || (query as QueryOptions).values
+ ? format(query.sql, values || (query as QueryOptions).values)
+ : query.sql;
+ }
+}
+
+/**
+ * The span name SHOULD be set to a low cardinality value
+ * representing the statement executed on the database.
+ *
+ * @returns SQL statement without variable arguments or SQL verb
+ */
+export function getSpanName(query: string | Query | QueryOptions): string {
+ if (typeof query === 'object') {
+ return query.sql;
+ }
+ return query.split(' ')[0];
+}
+
+export const once = (fn: Function) => {
+ let called = false;
+ return (...args: unknown[]) => {
+ if (called) return;
+ called = true;
+ return fn(...args);
+ };
+};
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/src/version.ts b/plugins/node/opentelemetry-instrumentation-mysql2/src/version.ts
new file mode 100644
index 0000000000..a14ba6ef88
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/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.20.0';
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/test.js b/plugins/node/opentelemetry-instrumentation-mysql2/test.js
new file mode 100644
index 0000000000..f5e5b13d0b
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/test.js
@@ -0,0 +1,22 @@
+const mysql = require('mysql');
+
+process.env.MYSQL_HOST = '';
+const port = Number(process.env.MYSQL_PORT) || 33306;
+const database = process.env.MYSQL_DATABASE || 'test_db';
+const host = process.env.MYSQL_HOST || '127.0.0.1';
+const user = process.env.MYSQL_USER || 'otel';
+const password = process.env.MYSQL_PASSWORD || 'secret';
+
+const connection = mysql.createConnection({
+ port,
+ user,
+ host,
+ password,
+ database,
+});
+
+const q = connection.query('select 1+2')
+
+q.on('result', console.log);
+q.on('end', console.log);
+q.on('error', console.log);
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/test/mysql.test.ts b/plugins/node/opentelemetry-instrumentation-mysql2/test/mysql.test.ts
new file mode 100644
index 0000000000..6f010f7bd0
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/test/mysql.test.ts
@@ -0,0 +1,661 @@
+/*
+ * 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, SpanStatusCode } from '@opentelemetry/api';
+import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
+import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import * as testUtils from '@opentelemetry/test-utils';
+import {
+ BasicTracerProvider,
+ InMemorySpanExporter,
+ ReadableSpan,
+ SimpleSpanProcessor,
+} from '@opentelemetry/tracing';
+import * as assert from 'assert';
+import { MySQL2Instrumentation } from '../src';
+
+const port = Number(process.env.MYSQL_PORT) || 33306;
+const database = process.env.MYSQL_DATABASE || 'test_db';
+const host = process.env.MYSQL_HOST || '127.0.0.1';
+const user = process.env.MYSQL_USER || 'otel';
+const password = process.env.MYSQL_PASSWORD || 'secret';
+
+const instrumentation = new MySQL2Instrumentation();
+instrumentation.enable();
+instrumentation.disable();
+
+import * as mysqlTypes from 'mysql2';
+
+interface Result extends mysqlTypes.RowDataPacket {
+ solution: number;
+}
+
+describe('mysql@2.x', () => {
+ let contextManager: AsyncHooksContextManager;
+ let connection: mysqlTypes.Connection;
+ let pool: mysqlTypes.Pool;
+ let poolCluster: mysqlTypes.PoolCluster;
+ const provider = new BasicTracerProvider();
+ const testMysql = process.env.RUN_MYSQL_TESTS; // For CI: assumes local mysql db is already available
+ const testMysqlLocally = process.env.RUN_MYSQL_TESTS_LOCAL; // For local: spins up local mysql db via docker
+ const shouldTest = testMysql || testMysqlLocally; // Skips these tests if false (default)
+ const memoryExporter = new InMemorySpanExporter();
+
+ before(function (done) {
+ if (!shouldTest) {
+ // this.skip() workaround
+ // https://github.com/mochajs/mocha/issues/2683#issuecomment-375629901
+ this.test!.parent!.pending = true;
+ this.skip();
+ }
+ provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter));
+ if (testMysqlLocally) {
+ testUtils.startDocker('mysql');
+ // wait 15 seconds for docker container to start
+ this.timeout(20000);
+ setTimeout(done, 15000);
+ } else {
+ done();
+ }
+ });
+
+ after(function () {
+ if (testMysqlLocally) {
+ this.timeout(5000);
+ testUtils.cleanUpDocker('mysql');
+ }
+ });
+
+ beforeEach(() => {
+ instrumentation.disable();
+ contextManager = new AsyncHooksContextManager().enable();
+ context.setGlobalContextManager(contextManager);
+ instrumentation.setTracerProvider(provider);
+ instrumentation.enable();
+ connection = mysqlTypes.createConnection({
+ port,
+ user,
+ host,
+ password,
+ database,
+ });
+ pool = mysqlTypes.createPool({
+ port,
+ user,
+ host,
+ password,
+ database,
+ });
+ poolCluster = mysqlTypes.createPoolCluster();
+ // the implementation actually accepts ConnectionConfig as well,
+ // but the types do not reflect that
+ poolCluster.add('name', {
+ port,
+ user,
+ host,
+ password,
+ database,
+ } as mysqlTypes.PoolClusterOptions);
+ });
+
+ afterEach(done => {
+ context.disable();
+ memoryExporter.reset();
+ instrumentation.disable();
+ connection.end(() => {
+ pool.end(() => {
+ // PoolCluster.end types in the package are invalid
+ // https://github.com/sidorares/node-mysql2/pull/1332
+ (poolCluster as any).end(() => {
+ done();
+ });
+ });
+ });
+ });
+
+ describe('when the query is a string', () => {
+ it('should name the span accordingly ', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ const query = connection.query(sql);
+
+ query.on('end', () => {
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans[0].name, 'SELECT');
+ done();
+ });
+ });
+ });
+ });
+
+ describe('when the query is an object', () => {
+ it('should name the span accordingly ', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ const query = connection.query({ sql, values: [1] });
+
+ query.on('end', () => {
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans[0].name, sql);
+ done();
+ });
+ });
+ });
+ });
+
+ describe('#Connection', () => {
+ it('should intercept connection.query(text: string)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ const query = connection.query(sql);
+ let rows = 0;
+
+ query.on('result', (row: mysqlTypes.RowDataPacket) => {
+ assert.strictEqual(row.solution, 2);
+ rows += 1;
+ });
+
+ query.on('end', () => {
+ assert.strictEqual(rows, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+
+ it('should intercept connection.query(text: string, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ connection.query(sql, (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+
+ it('should intercept connection.query(text: options, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ connection.query(
+ { sql, values: [1] },
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+
+ it('should intercept connection.query(text: options, values: [], callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ connection.query(
+ { sql },
+ [1],
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+
+ it('should intercept connection.query(text: string, values: [], callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ connection.query(sql, [1], (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ });
+ });
+ });
+
+ it('should intercept connection.query(text: string, value: any, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ connection.query(sql, 1, (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ });
+ });
+ });
+
+ it('should attach error messages to spans', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ connection.query(sql, (err, res) => {
+ assert.ok(err);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, undefined, err!.message);
+ done();
+ });
+ });
+ });
+ });
+
+ describe('#Pool', () => {
+ it('should intercept pool.query(text: string)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ const query = pool.query(sql);
+ let rows = 0;
+
+ query.on('result', (row: mysqlTypes.RowDataPacket) => {
+ assert.strictEqual(row.solution, 2);
+ rows += 1;
+ });
+
+ query.on('end', () => {
+ assert.strictEqual(rows, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+
+ it('should intercept pool.getConnection().query(text: string)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ pool.getConnection((err, conn) => {
+ const query = conn.query(sql);
+ let rows = 0;
+
+ query.on('result', (row: mysqlTypes.RowDataPacket) => {
+ assert.strictEqual(row.solution, 2);
+ rows += 1;
+ });
+
+ query.on('end', () => {
+ assert.strictEqual(rows, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+ });
+
+ it('should intercept pool.query(text: string, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ pool.query(sql, (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+
+ it('should intercept pool.getConnection().query(text: string, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ pool.getConnection((err, conn) => {
+ conn.query(sql, (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+ });
+
+ it('should intercept pool.query(text: options, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ pool.query(
+ { sql, values: [1] },
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+
+ it('should intercept pool.query(text: options, values: [], callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ pool.query({ sql }, [1], (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ });
+ });
+ });
+
+ it('should intercept pool.query(text: string, values: [], callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ pool.query(sql, [1], (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ });
+ });
+ });
+
+ it('should intercept pool.query(text: string, value: any, callback)', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ pool.query(sql, 1, (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ });
+ });
+ });
+
+ it('should attach error messages to spans', done => {
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ pool.query(sql, (err, res) => {
+ assert.ok(err);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, undefined, err!.message);
+ done();
+ });
+ });
+ });
+ });
+
+ describe('#PoolCluster', () => {
+ it('should intercept poolClusterConnection.query(text: string)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ const query = poolClusterConnection.query(sql);
+ let rows = 0;
+
+ query.on('result', (row: mysqlTypes.RowDataPacket) => {
+ assert.strictEqual(row.solution, 2);
+ rows += 1;
+ });
+
+ query.on('end', () => {
+ assert.strictEqual(rows, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+ });
+
+ it('should intercept poolClusterConnection.query(text: string, callback)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+1 as solution';
+ poolClusterConnection.query(
+ sql,
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ }
+ );
+ });
+ });
+ });
+
+ it('should intercept poolClusterConnection.query(text: options, callback)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ poolClusterConnection.query(
+ { sql, values: [1] },
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+ });
+
+ it('should intercept poolClusterConnection.query(text: options, values: [], callback)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1+? as solution';
+ poolClusterConnection.query(
+ { sql },
+ [1],
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 2);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+ });
+
+ it('should intercept poolClusterConnection.query(text: string, values: [], callback)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ poolClusterConnection.query(
+ sql,
+ [1],
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+ });
+
+ it('should intercept poolClusterConnection.query(text: string, value: any, callback)', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ poolClusterConnection.query(
+ sql,
+ 1,
+ (err, res: mysqlTypes.RowDataPacket[]) => {
+ assert.ifError(err);
+ assert.ok(res);
+ assert.strictEqual(res[0].solution, 1);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, [1]);
+ done();
+ }
+ );
+ });
+ });
+ });
+
+ it('should attach error messages to spans', done => {
+ poolCluster.getConnection((err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT ? as solution';
+ poolClusterConnection.query(sql, (err, res) => {
+ assert.ok(err);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql, undefined, err!.message);
+ done();
+ });
+ });
+ });
+ });
+
+ it('should get connection by name', done => {
+ poolCluster.getConnection('name', (err, poolClusterConnection) => {
+ assert.ifError(err);
+ const span = provider.getTracer('default').startSpan('test span');
+ context.with(trace.setSpan(context.active(), span), () => {
+ const sql = 'SELECT 1 as solution';
+ poolClusterConnection.query(sql, (err, res) => {
+ assert.ifError(err);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ });
+ });
+ });
+
+ it('should get connection by name and selector', done => {
+ poolCluster.getConnection(
+ 'name',
+ 'ORDER',
+ (err, poolClusterConnection) => {
+ assert.ifError(err);
+ const sql = 'SELECT 1 as solution';
+ poolClusterConnection.query(sql, (err, res) => {
+ assert.ifError(err);
+ const spans = memoryExporter.getFinishedSpans();
+ assert.strictEqual(spans.length, 1);
+ assertSpan(spans[0], sql);
+ done();
+ });
+ }
+ );
+ });
+ });
+});
+
+function assertSpan(
+ span: ReadableSpan,
+ sql: string,
+ values?: any,
+ errorMessage?: string
+) {
+ assert.strictEqual(span.attributes[SemanticAttributes.DB_SYSTEM], 'mysql');
+ assert.strictEqual(span.attributes[SemanticAttributes.DB_NAME], database);
+ assert.strictEqual(span.attributes[SemanticAttributes.NET_PEER_PORT], port);
+ assert.strictEqual(span.attributes[SemanticAttributes.NET_PEER_NAME], host);
+ assert.strictEqual(span.attributes[SemanticAttributes.DB_USER], user);
+ assert.strictEqual(
+ span.attributes[SemanticAttributes.DB_STATEMENT],
+ mysqlTypes.format(sql, values)
+ );
+ if (errorMessage) {
+ assert.strictEqual(span.status.message, errorMessage);
+ assert.strictEqual(span.status.code, SpanStatusCode.ERROR);
+ }
+}
diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/tsconfig.json b/plugins/node/opentelemetry-instrumentation-mysql2/tsconfig.json
new file mode 100644
index 0000000000..28be80d266
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql2/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}