diff --git a/package-lock.json b/package-lock.json index 038ab3078a..888f3ea4fe 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10352,6 +10352,10 @@ "resolved": "plugins/node/opentelemetry-instrumentation-mysql2", "link": true }, + "node_modules/@opentelemetry/instrumentation-mysql2-promise": { + "resolved": "plugins/node/opentelemetry-instrumentation-mysql2-promise", + "link": true + }, "node_modules/@opentelemetry/instrumentation-nestjs-core": { "resolved": "plugins/node/opentelemetry-instrumentation-nestjs-core", "link": true @@ -37838,6 +37842,47 @@ "@opentelemetry/api": "^1.3.0" } }, + "plugins/node/opentelemetry-instrumentation-mysql2-promise": { + "name": "@opentelemetry/instrumentation-mysql2-promise", + "version": "0.42.0", + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/instrumentation": "^0.54.0", + "@opentelemetry/semantic-conventions": "^1.27.0", + "@opentelemetry/sql-common": "^0.40.1" + }, + "devDependencies": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/context-async-hooks": "^1.8.0", + "@opentelemetry/contrib-test-utils": "^0.42.0", + "@opentelemetry/sdk-trace-base": "^1.8.0", + "@types/mocha": "7.0.2", + "@types/node": "18.18.14", + "@types/semver": "7.5.8", + "mysql2": "3.11.3", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "semver": "7.6.3", + "test-all-versions": "6.1.0", + "typescript": "4.4.4" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + } + }, + "plugins/node/opentelemetry-instrumentation-mysql2-promise/node_modules/@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~5.26.4" + } + }, "plugins/node/opentelemetry-instrumentation-mysql2/node_modules/@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -48545,6 +48590,38 @@ } } }, + "@opentelemetry/instrumentation-mysql2-promise": { + "version": "file:plugins/node/opentelemetry-instrumentation-mysql2-promise", + "requires": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/context-async-hooks": "^1.8.0", + "@opentelemetry/contrib-test-utils": "^0.42.0", + "@opentelemetry/instrumentation": "^0.54.0", + "@opentelemetry/sdk-trace-base": "^1.8.0", + "@opentelemetry/semantic-conventions": "^1.27.0", + "@opentelemetry/sql-common": "^0.40.1", + "@types/mocha": "7.0.2", + "@types/node": "18.18.14", + "@types/semver": "7.5.8", + "mysql2": "3.11.3", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "semver": "7.6.3", + "test-all-versions": "6.1.0", + "typescript": "4.4.4" + }, + "dependencies": { + "@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "requires": { + "undici-types": "~5.26.4" + } + } + } + }, "@opentelemetry/instrumentation-nestjs-core": { "version": "file:plugins/node/opentelemetry-instrumentation-nestjs-core", "requires": { diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/.eslintignore b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.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-promise/.tav.yml b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.tav.yml new file mode 100644 index 0000000000..10c6cee55b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/.tav.yml @@ -0,0 +1,8 @@ +mysql2: + versions: + include: ">=1.4.2 <4" + # Skip v1.6.2, which is broken + # Skip 2.3.3 which installs types from git which takes 10m on it's own + exclude: "1.6.2 || 2.3.3" + mode: latest-minors + commands: npm run test diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/LICENSE b/plugins/node/opentelemetry-instrumentation-mysql2-promise/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/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-promise/README.md b/plugins/node/opentelemetry-instrumentation-mysql2-promise/README.md new file mode 100644 index 0000000000..b91c8038d6 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/README.md @@ -0,0 +1,82 @@ +# OpenTelemetry mysql Instrumentation for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for the [`mysql2/promise`](https://github.com/sidorares/node-mysql2) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. + +If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-mysql2-promise +``` + +## Supported Versions + +- [`mysql2`](https://www.npmjs.com/package/mysql2) versions `>=1.4.2 <4` + +## 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/sdk-trace-node'); +const { MySQL2PromiseInstrumentation } = require('@opentelemetry/instrumentation-mysql2-promise'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new MySQL2PromiseInstrumentation(), + ], +}) +``` + +### MySQL2 Instrumentation Options + +You can set the following instrumentation options: + +| Options | Type | Description | +|-----------------------------------|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `responseHook` | `MySQL2PromiseInstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response | +| `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ | + +## Semantic Conventions + +This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md) + +Attributes collected: + +| Attribute | Short Description | +|------------------------|-----------------------------------------------------------------------------| +| `db.connection_string` | The connection string used to connect to the database. | +| `db.name` | This attribute is used to report the name of the database being accessed. | +| `db.statement` | The database statement being executed. | +| `db.system` | An identifier for the database management system (DBMS) product being used. | +| `db.user` | Username for accessing the database. | +| `net.peer.name` | Remote hostname or similar. | +| `net.peer.port` | Remote port number. | + +## 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 +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-mysql2-promise +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-mysql2-promise.svg diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/env b/plugins/node/opentelemetry-instrumentation-mysql2-promise/env new file mode 100644 index 0000000000..5c3993ada9 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/env @@ -0,0 +1,5 @@ +export MYSQL_DATABASE=otel_mysql_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-promise/package.json b/plugins/node/opentelemetry-instrumentation-mysql2-promise/package.json new file mode 100644 index 0000000000..4cc90480c8 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/package.json @@ -0,0 +1,66 @@ +{ + "name": "@opentelemetry/instrumentation-mysql2-promise", + "version": "0.42.0", + "description": "OpenTelemetry instrumentation for `mysql2/promise` database client for MySQL", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "compile": "tsc -p .", + "lint:fix": "eslint . --ext .ts --fix", + "lint": "eslint . --ext .ts", + "prewatch": "npm run precompile", + "prepublishOnly": "npm run compile", + "tdd": "npm run test -- --watch-extensions ts --watch", + "test": "nyc mocha 'test/**/*.test.ts'", + "test-all-versions": "tav", + "version:update": "node ../../../scripts/version-update.js" + }, + "keywords": [ + "instrumentation", + "mysql", + "mysql2", + "nodejs", + "opentelemetry", + "profiling", + "tracing" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/context-async-hooks": "^1.8.0", + "@opentelemetry/contrib-test-utils": "^0.42.0", + "@opentelemetry/sdk-trace-base": "^1.8.0", + "@types/mocha": "7.0.2", + "@types/node": "18.18.14", + "@types/semver": "7.5.8", + "mysql2": "3.11.3", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "semver": "7.6.3", + "test-all-versions": "6.1.0", + "typescript": "4.4.4" + }, + "dependencies": { + "@opentelemetry/instrumentation": "^0.54.0", + "@opentelemetry/semantic-conventions": "^1.27.0", + "@opentelemetry/sql-common": "^0.40.1" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql2-promise#readme" +} diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/index.ts b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/index.ts new file mode 100644 index 0000000000..c26f998cff --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/index.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. + */ + +export * from './instrumentation'; +export * from './types'; diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/instrumentation.ts new file mode 100644 index 0000000000..3e53f3c0cb --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/instrumentation.ts @@ -0,0 +1,203 @@ +/* + * 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, + safeExecuteInTheMiddle, +} from '@opentelemetry/instrumentation'; +import { + DBSYSTEMVALUES_MYSQL, + SEMATTRS_DB_STATEMENT, + SEMATTRS_DB_SYSTEM, +} from '@opentelemetry/semantic-conventions'; +import { addSqlCommenterComment } from '@opentelemetry/sql-common'; +import type * as mysqlTypes from 'mysql2/promise'; +import { MySQL2PromiseInstrumentationConfig } from './types'; +import { getConnectionAttributes, getDbStatement, getSpanName } from './utils'; +/** @knipignore */ +import { PACKAGE_NAME, PACKAGE_VERSION } from './version'; + +type formatType = typeof mysqlTypes.format; + +export class MySQL2PromiseInstrumentation extends InstrumentationBase { + static readonly COMMON_ATTRIBUTES = { + [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_MYSQL, + }; + + constructor(config: MySQL2PromiseInstrumentationConfig = {}) { + super(PACKAGE_NAME, PACKAGE_VERSION, config); + } + + protected init() { + return [ + new InstrumentationNodeModuleDefinition( + 'mysql2/promise.js', + ['>=1.4.2 <4'], + (moduleExports: any) => { + const ConnectionPrototype: mysqlTypes.Connection = + moduleExports.PromiseConnection.prototype; + if (isWrapped(ConnectionPrototype.query)) { + this._unwrap(ConnectionPrototype, 'query'); + } + this._wrap( + ConnectionPrototype, + 'query', + this._patchQuery(moduleExports.format, false) as any + ); + + if (isWrapped(ConnectionPrototype.execute)) { + this._unwrap(ConnectionPrototype, 'execute'); + } + this._wrap( + ConnectionPrototype, + 'execute', + this._patchQuery(moduleExports.format, true) as any + ); + + const PoolPrototype: mysqlTypes.Pool = + moduleExports.PromisePool.prototype; + if (isWrapped(PoolPrototype.query)) { + this._unwrap(PoolPrototype, 'query'); + } + this._wrap( + PoolPrototype, + 'query', + this._patchQuery(moduleExports.format, false) as any + ); + + if (isWrapped(PoolPrototype.execute)) { + this._unwrap(PoolPrototype, 'execute'); + } + this._wrap( + PoolPrototype, + 'execute', + this._patchQuery(moduleExports.format, true) as any + ); + + return moduleExports; + }, + (moduleExports: any) => { + if (moduleExports === undefined) return; + const ConnectionPrototype: mysqlTypes.Connection = + moduleExports.PromiseConnection.prototype; + this._unwrap(ConnectionPrototype, 'query'); + this._unwrap(ConnectionPrototype, 'execute'); + + const PoolPrototype: mysqlTypes.Connection = + moduleExports.PromisePool.prototype; + this._unwrap(PoolPrototype, 'query'); + this._unwrap(PoolPrototype, 'execute'); + } + ), + ]; + } + + private _patchQuery(format: formatType, isPrepared: boolean) { + return (originalQuery: Function): Function => { + const thisPlugin = this; + return async function query( + this: mysqlTypes.Connection | mysqlTypes.Pool, + query: string | mysqlTypes.QueryOptions, + _values: any + ) { + let values; + if (Array.isArray(_values)) { + values = _values; + } else if (_values) { + values = [_values]; + } + + const span = thisPlugin.tracer.startSpan(getSpanName(query), { + kind: api.SpanKind.CLIENT, + attributes: { + ...MySQL2PromiseInstrumentation.COMMON_ATTRIBUTES, + ...getConnectionAttributes( + 'pool' in this ? this.pool.config : this.config + ), + [SEMATTRS_DB_STATEMENT]: getDbStatement(query, format, values), + }, + }); + + if ( + !isPrepared && + thisPlugin.getConfig().addSqlCommenterCommentToQueries + ) { + arguments[0] = + typeof query === 'string' + ? addSqlCommenterComment(span, query) + : Object.assign(query, { + sql: addSqlCommenterComment(span, query.sql), + }); + } + + let promise: Promise< + [mysqlTypes.QueryResult, mysqlTypes.FieldPacket[]] + >; + try { + promise = originalQuery.apply(this, arguments); + } catch (error: any) { + span.setStatus({ + code: api.SpanStatusCode.ERROR, + message: error.message, + }); + span.end(); + throw error; + } + + return promise + .then(result => { + // Return a pass-along promise which ends the span and then goes to user's orig resolvers + return new Promise(resolve => { + const { responseHook } = thisPlugin.getConfig(); + if (typeof responseHook === 'function') { + safeExecuteInTheMiddle( + () => { + responseHook(span, { + queryResults: result[0], + }); + }, + error => { + if (error) { + thisPlugin._diag.warn( + 'Failed executing responseHook', + error + ); + } + }, + true + ); + } + span.end(); + resolve(result); + }); + }) + .catch((error: any) => { + return new Promise((_, reject) => { + span.setStatus({ + code: api.SpanStatusCode.ERROR, + message: error.message, + }); + span.end(); + reject(error); + }); + }); + }; + }; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/types.ts b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/types.ts new file mode 100644 index 0000000000..0b015ac05f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/types.ts @@ -0,0 +1,43 @@ +/* + * 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'; +import type { Span } from '@opentelemetry/api'; + +export interface MySQL2PromiseResponseHookInformation { + queryResults: any; +} + +export interface MySQL2PromiseInstrumentationExecutionResponseHook { + (span: Span, responseHookInfo: MySQL2PromiseResponseHookInformation): void; +} + +export interface MySQL2PromiseInstrumentationConfig + extends InstrumentationConfig { + /** + * Hook that allows adding custom span attributes based on the data + * returned MySQL2 queries. + * + * @default undefined + */ + responseHook?: MySQL2PromiseInstrumentationExecutionResponseHook; + + /** + * If true, queries are modified to also include a comment with + * the tracing context, following the {@link https://github.com/open-telemetry/opentelemetry-sqlcommenter sqlcommenter} format + */ + addSqlCommenterCommentToQueries?: boolean; +} diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/utils.ts b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/utils.ts new file mode 100644 index 0000000000..57dfd09565 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/src/utils.ts @@ -0,0 +1,135 @@ +/* + * 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 { Attributes } from '@opentelemetry/api'; +import { + SEMATTRS_DB_CONNECTION_STRING, + SEMATTRS_DB_NAME, + SEMATTRS_DB_USER, + SEMATTRS_NET_PEER_NAME, + SEMATTRS_NET_PEER_PORT, +} from '@opentelemetry/semantic-conventions'; + +/* + Following types declare an expectation on mysql2 types and define a subset we + use in the instrumentation of the types actually defined in mysql2 package + + We need to import them here so that the installing party of the instrumentation + doesn't have to absolutely install the mysql2 package as well - specially + important for auto-loaders and meta-packages. +*/ +interface QueryOptions { + sql: string; + values?: any | any[] | { [param: string]: any }; +} + +interface Config { + host?: string; + port?: number; + database?: string; + user?: string; + connectionConfig?: Config; +} +/** + * Get an Attributes map from a mysql connection config object + * + * @param config ConnectionConfig + */ +export function getConnectionAttributes(config: Config): Attributes { + const { host, port, database, user } = getConfig(config); + const portNumber = parseInt(port, 10); + if (!isNaN(portNumber)) { + return { + [SEMATTRS_NET_PEER_NAME]: host, + [SEMATTRS_NET_PEER_PORT]: portNumber, + [SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database), + [SEMATTRS_DB_NAME]: database, + [SEMATTRS_DB_USER]: user, + }; + } + return { + [SEMATTRS_NET_PEER_NAME]: host, + [SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database), + [SEMATTRS_DB_NAME]: database, + [SEMATTRS_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 | 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 | QueryOptions): string { + const rawQuery = typeof query === 'object' ? query.sql : query; + // Extract the SQL verb + const firstSpace = rawQuery?.indexOf(' '); + if (typeof firstSpace === 'number' && firstSpace !== -1) { + return rawQuery?.substring(0, firstSpace); + } + return rawQuery; +} diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/test/mysql.test.ts b/plugins/node/opentelemetry-instrumentation-mysql2-promise/test/mysql.test.ts new file mode 100644 index 0000000000..a3c2e0005b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/test/mysql.test.ts @@ -0,0 +1,980 @@ +/* + * 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 semver from 'semver'; +import { context, trace, SpanStatusCode } from '@opentelemetry/api'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { + DBSYSTEMVALUES_MYSQL, + SEMATTRS_DB_NAME, + SEMATTRS_DB_STATEMENT, + SEMATTRS_DB_SYSTEM, + SEMATTRS_DB_USER, + SEMATTRS_NET_PEER_NAME, + SEMATTRS_NET_PEER_PORT, +} from '@opentelemetry/semantic-conventions'; +import * as testUtils from '@opentelemetry/contrib-test-utils'; +import { + BasicTracerProvider, + InMemorySpanExporter, + ReadableSpan, + SimpleSpanProcessor, +} from '@opentelemetry/sdk-trace-base'; +import * as assert from 'assert'; +import { + MySQL2PromiseInstrumentation, + MySQL2PromiseInstrumentationConfig, +} from '../src'; + +const LIB_VERSION = testUtils.getPackageVersion('mysql2'); +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 rootPassword = process.env.MYSQL_ROOT_PASSWORD || 'rootpw'; + +const instrumentation = new MySQL2PromiseInstrumentation(); +instrumentation.enable(); +instrumentation.disable(); + +import * as mysqlTypes from 'mysql2/promise'; + +interface GeneralLogResult extends mysqlTypes.RowDataPacket { + argument: string | Buffer; +} + +interface Result extends mysqlTypes.RowDataPacket { + solution: number; +} + +describe('mysql2/promise', () => { + let contextManager: AsyncHooksContextManager; + let connection: mysqlTypes.Connection; + let rootConnection: 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(); + + const getLastQueries = async (count: number) => { + const [rows] = await rootConnection.query({ + sql: "SELECT * FROM mysql.general_log WHERE command_type = 'Query' ORDER BY event_time DESC LIMIT ? OFFSET 1", + values: [count], + }); + + return rows.map(row => { + if (typeof row.argument === 'string') { + return row.argument; + } else { + return row.argument.toString('utf-8'); + } + }); + }; + + before(async function () { + 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)); + rootConnection = await mysqlTypes.createConnection({ + port, + user: 'root', + host, + password: rootPassword, + database, + }); + if (testMysqlLocally) { + testUtils.startDocker('mysql'); + // wait 15 seconds for docker container to start + this.timeout(20000); + await new Promise(resolve => setTimeout(resolve, 15000)); + } + }); + + after(async function () { + await rootConnection.end(); + if (testMysqlLocally) { + this.timeout(5000); + testUtils.cleanUpDocker('mysql'); + } + }); + + beforeEach(async () => { + instrumentation.disable(); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); + instrumentation.setTracerProvider(provider); + instrumentation.enable(); + connection = await 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, + }); + }); + + afterEach(async () => { + context.disable(); + memoryExporter.reset(); + instrumentation.setConfig({}); + instrumentation.disable(); + await connection.end(); + await pool.end(); + if (isPoolClusterEndIgnoreCallback()) { + await poolCluster.end(); + } else { + await poolCluster.end(); + } + }); + + describe('when the query is a string', () => { + it('should name the span accordingly ', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + await connection.query(sql); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assert.strictEqual(spans[0].name, 'SELECT'); + assertSpan(spans[0], sql); + }); + }); + }); + + describe('when the query is an object', () => { + it('should name the span accordingly ', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + await connection.query({ sql, values }); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assert.strictEqual(spans[0].name, 'SELECT'); + assertSpan(spans[0], sql, values); + }); + }); + }); + + describe('#Connection.query', () => { + it('should intercept connection.query(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.query(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept connection.query(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + const values = [1]; + const [rows] = await connection.query(sql, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 1); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept connection.query(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.query({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept connection.query(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + const values = [1]; + const [rows] = await connection.query({ sql }, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 1); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should attach error messages to spans', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + + try { + await connection.query(sql); + } catch (error: any) { + assert.ok(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, undefined, error.message); + } + }); + }); + + it('should not add comment by default', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await connection.query('SELECT 1+1 as solution'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should not add comment when specified if existing block comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await connection.query('SELECT 1+1 as solution /*block comment*/'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should not add comment when specified if existing line comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await connection.query('SELECT 1+1 as solution -- line comment'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should add comment when specified if no existing comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await connection.query('SELECT 1+1 as solution'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.match(query, /.*traceparent.*/); + }); + }); + }); + + describe('#Connection.execute', () => { + it('should intercept connection.execute(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.execute(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept connection.execute(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await connection.execute(sql, values); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept connection.execute(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.execute({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept connection.execute(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await connection.execute({ sql }, values); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should attach error messages to spans', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + + try { + await connection.execute(sql); + } catch (error: any) { + assert.ok(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, undefined, error.message); + } + }); + }); + }); + + describe('#Pool.query', () => { + it('should intercept pool.query(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await pool.query(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.query(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await pool.query(sql, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.query(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await pool.query({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.query(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await pool.query({ sql }, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.getConnection().query(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const conn = await pool.getConnection(); + const [rows] = await conn.query(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.getConnection().query(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const conn = await pool.getConnection(); + const [rows] = await conn.query(sql, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.getConnection().query(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const conn = await pool.getConnection(); + const [rows] = await conn.query({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.getConnection().query(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const conn = await pool.getConnection(); + const [rows] = await conn.query({ sql }, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should attach error messages to spans', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + + try { + await pool.query(sql); + } catch (error: any) { + assert.ok(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, undefined, error.message); + } + }); + }); + + it('should not add comment by default', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await pool.query('SELECT 1+1 as solution'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should not add comment when specified if existing block comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await pool.query('SELECT 1+1 as solution /*block comment*/'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should not add comment when specified if existing line comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await pool.query('SELECT 1+1 as solution -- line comment'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.doesNotMatch(query, /.*traceparent.*/); + }); + }); + + it('should add comment when specified if no existing comment', async () => { + instrumentation.setConfig({ + addSqlCommenterCommentToQueries: true, + } as any); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + await pool.query('SELECT 1+1 as solution'); + + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + const [query] = await getLastQueries(1); + assert.match(query, /.*traceparent.*/); + }); + }); + }); + + describe('#Pool.execute', () => { + it('should intercept pool.execute(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await pool.execute(sql); + + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.execute(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await pool.execute(sql, values); + + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.execute(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await pool.execute({ sql }); + + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.execute(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await pool.execute({ sql }, values); + + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.getConnection().execute(text: string)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const conn = await pool.getConnection(); + const [rows] = await conn.execute(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.getConnection().execute(text: string, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const conn = await pool.getConnection(); + const [rows] = await conn.execute(sql, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept pool.getConnection().execute(options: QueryOptions)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const conn = await pool.getConnection(); + const [rows] = await conn.execute({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept pool.getConnection().execute(options: QueryOptions, values: any)', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const conn = await pool.getConnection(); + const [rows] = await conn.execute({ sql }, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should attach error messages to spans', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + + try { + await pool.execute(sql); + } catch (error: any) { + assert.ok(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, undefined, error.message); + } + }); + }); + }); + + describe('#PoolCluster', () => { + it('should intercept poolClusterConnection.query(text: string)', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await poolClusterConnection.query(sql); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept poolClusterConnection.query(text: string, values: any)', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await poolClusterConnection.query(sql, values); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should intercept poolClusterConnection.query(options: QueryOptions)', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await poolClusterConnection.query({ sql }); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + }); + }); + + it('should intercept poolClusterConnection.query(options: QueryOptions, values: any)', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+? as solution'; + const values = [1]; + const [rows] = await poolClusterConnection.query( + { sql }, + values + ); + + assert.strictEqual(rows.length, 1); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql, values); + }); + }); + + it('should attach error messages to spans', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT ? as solution'; + + try { + await poolClusterConnection.query(sql); + } catch (error) { + assert.ok(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + // eslint-disable-next-line @typescript-eslint/ban-ts-comment + // @ts-ignore + assertSpan(spans[0], sql, undefined, error!.message); + } + }); + }); + + it('should get connection by name', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1 as solution'; + + try { + await poolClusterConnection.query(sql); + } catch (error) { + assert.ifError(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + } + }); + }); + + it('should get connection by name and selector', async () => { + const poolClusterConnection = await poolCluster.getConnection( + 'name', + 'ORDER' + ); + + const sql = 'SELECT 1 as solution'; + + try { + await poolClusterConnection.query(sql); + } catch (error) { + assert.ifError(error); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + } + }); + }); + + describe('#responseHook', () => { + const queryResultAttribute = 'query_result'; + + describe('invalid response hook', () => { + beforeEach(() => { + const config: MySQL2PromiseInstrumentationConfig = { + responseHook: (span, responseHookInfo) => { + throw new Error('random failure!'); + }, + }; + instrumentation.setConfig(config); + }); + + it('should not affect the behavior of the query', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.query(sql); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + }); + }); + }); + + describe('valid response hook', () => { + beforeEach(() => { + const config: MySQL2PromiseInstrumentationConfig = { + responseHook: (span, responseHookInfo) => { + span.setAttribute( + queryResultAttribute, + JSON.stringify(responseHookInfo.queryResults) + ); + }, + }; + instrumentation.setConfig(config); + }); + + it('should extract data from responseHook - connection', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await connection.query(sql); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + assert.strictEqual( + spans[0].attributes[queryResultAttribute], + JSON.stringify(rows) + ); + }); + }); + + it('should extract data from responseHook - pool', async () => { + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const conn = await pool.getConnection(); + const [rows] = await conn.query(sql); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + assert.strictEqual( + spans[0].attributes[queryResultAttribute], + JSON.stringify(rows) + ); + }); + }); + + it('should extract data from responseHook - poolCluster', async () => { + const poolClusterConnection = await poolCluster.getConnection(); + const span = provider.getTracer('default').startSpan('test span'); + await context.with(trace.setSpan(context.active(), span), async () => { + const sql = 'SELECT 1+1 as solution'; + const [rows] = await poolClusterConnection.query(sql); + + assert.ok(rows); + assert.strictEqual(rows[0].solution, 2); + const spans = memoryExporter.getFinishedSpans(); + assert.strictEqual(spans.length, 1); + assertSpan(spans[0], sql); + assert.strictEqual( + spans[0].attributes[queryResultAttribute], + JSON.stringify(rows) + ); + }); + }); + }); + }); +}); + +function assertSpan( + span: ReadableSpan, + sql: string, + values?: any, + errorMessage?: string +) { + assert.strictEqual(span.attributes[SEMATTRS_DB_SYSTEM], DBSYSTEMVALUES_MYSQL); + assert.strictEqual(span.attributes[SEMATTRS_DB_NAME], database); + assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_PORT], port); + assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_NAME], host); + assert.strictEqual(span.attributes[SEMATTRS_DB_USER], user); + assert.strictEqual( + span.attributes[SEMATTRS_DB_STATEMENT], + mysqlTypes.format(sql, values) + ); + if (errorMessage) { + assert.strictEqual(span.status.message, errorMessage); + assert.strictEqual(span.status.code, SpanStatusCode.ERROR); + } +} + +function isPoolClusterEndIgnoreCallback() { + // Since v2.2.0 `end` function respect callback + // https://github.com/sidorares/node-mysql2/commit/1481015626e506754adc4308e5508356a3a03aa0 + return semver.lt(LIB_VERSION, '2.2.0'); +} diff --git a/plugins/node/opentelemetry-instrumentation-mysql2-promise/tsconfig.json b/plugins/node/opentelemetry-instrumentation-mysql2-promise/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-mysql2-promise/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +}