From 2d36e9e976c533209a0ad96e7ba3db7d0a8d7e8b Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Tue, 12 Jan 2021 16:49:49 +0100 Subject: [PATCH 01/14] feat: add ioredis instrumentation Created ioredis instrumentation because the plugin API will be removed from OTel. --- .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../.npmignore | 4 + .../LICENSE | 201 ++++++ .../README.md | 87 +++ .../package.json | 73 ++ .../src/index.ts | 17 + .../src/ioredis.ts | 93 +++ .../src/types.ts | 48 ++ .../src/utils.ts | 119 ++++ .../src/version.ts | 18 + .../test/ioredis.test.ts | 627 ++++++++++++++++++ .../tsconfig.json | 11 + 13 files changed, 1306 insertions(+) create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/.eslintignore create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/.eslintrc.js create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/.npmignore create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/LICENSE create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/README.md create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/package.json create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts create mode 100644 plugins/node/opentelemetry-instrumentation-ioredis/tsconfig.json diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/.eslintignore b/plugins/node/opentelemetry-instrumentation-ioredis/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-ioredis/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/.npmignore b/plugins/node/opentelemetry-instrumentation-ioredis/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/LICENSE b/plugins/node/opentelemetry-instrumentation-ioredis/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/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-ioredis/README.md b/plugins/node/opentelemetry-instrumentation-ioredis/README.md new file mode 100644 index 0000000000..f95242c9c8 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/README.md @@ -0,0 +1,87 @@ +# OpenTelemetry ioredis Instrumentation for Node.js + +[![Gitter chat][gitter-image]][gitter-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for [`ioredis`](https://github.com/luin/ioredis). + +For automatic instrumentation see the +[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package. + +## Installation + +```sh +npm install --save @opentelemetry/instrumentation-ioredis +``` + +### Supported Versions + - `>=2.0.0` + +## Usage + +To load a specific instrumentation (**ioredis** in this case), specify it in the Node Tracer's configuration + +```javascript +const { NodeTracerProvider } = require('@opentelemetry/node'); +const { IORedisInstrumentation } = require('@opentelemetry/instrumentation-ioredis'); + +const provider = new NodeTracerProvider({ + // be sure to disable old plugin + plugins: { + ioredis: { enabled: false, path: '@opentelemetry/plugin-ioredis' } + }, +}); +provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); +provider.register(); + +const ioredisInstrumentation = new IORedisInstrumentation({ + // see under for available configuration +}); + +``` + +### IORedis Instrumentation Options + +IORedis instrumentation has few options available to choose from. You can set the following: + +| Options | Type | Description | +| ------- | ---- | ----------- | +| `dbStatementSerializer` | `DbStatementSerializer` | IORedis instrumentation will serialize db.statement using the specified function. | + +#### Custom db.statement Serializer +The instrumentation serializes the whole command into a Span attribute called `db.statement`. The standard serialization format is `{cmdName} {cmdArgs.join(',')}`. +It is also possible to define a custom serialization function. The function will receive the command name and arguments and must return a string. + +Here is a simple example to serialize the command name skipping arguments: + +```javascript +const { IORedisInstrumentation } = require('@opentelemetry/instrumentation-ioredis'); + +const ioredisInstrumentation = new IORedisInstrumentation({ + dbStatementSerializer: function (cmdName, cmdArgs) { + return cmdName; + } +}); + +``` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us on [gitter][gitter-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg +[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-instrumentation-ioredis +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-ioredis +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-instrumentation-ioredis +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-ioredis&type=dev diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json new file mode 100644 index 0000000000..076d3bce48 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -0,0 +1,73 @@ +{ + "name": "@opentelemetry/instrumentation-ioredis", + "version": "0.12.0", + "description": "OpenTelemetry ioredis automatic instrumentation package.", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true ts-mocha --inspect-brk --no-timeouts -p tsconfig.json 'test/**/*.test.ts'", + "test:local": "cross-env RUN_REDIS_TESTS_LOCAL=true npm run test", + "tdd": "npm run test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version", + "version:update": "node ../../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p .", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "prepare": "npm run compile" + }, + "keywords": [ + "opentelemetry", + "ioredis", + "redis", + "nodejs", + "tracing", + "profiling", + "instrumentation" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.0.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/context-async-hooks": "^0.14.0", + "@opentelemetry/node": "^0.14.0", + "@opentelemetry/semantic-conventions": "^0.14.0", + "@opentelemetry/test-utils": "^0.12.0", + "@opentelemetry/tracing": "^0.14.0", + "@types/ioredis": "4.17.3", + "@types/mocha": "7.0.2", + "@types/node": "14.0.27", + "@types/shimmer": "1.0.1", + "codecov": "3.7.2", + "cross-env": "7.0.2", + "gts": "2.0.2", + "ioredis": "4.17.3", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "ts-mocha": "8.0.0", + "ts-node": "9.0.0", + "tslint-consistent-codestyle": "1.16.0", + "tslint-microsoft-contrib": "6.2.0", + "typescript": "3.9.7" + }, + "dependencies": { + "@opentelemetry/api": "^0.14.0", + "@opentelemetry/instrumentation": "^0.14.0" + } +} diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts new file mode 100644 index 0000000000..98bfff0f0d --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts @@ -0,0 +1,17 @@ +/* + * 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 './ioredis'; diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts new file mode 100644 index 0000000000..bebe026cd4 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts @@ -0,0 +1,93 @@ +/* + * 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 type * as ioredisTypes from 'ioredis'; +import { + InstrumentationBase, + InstrumentationConfig, + InstrumentationNodeModuleDefinition, + isWrapped, +} from '@opentelemetry/instrumentation'; +import { IORedisInstrumentationConfig } from './types'; +import { traceConnection, traceSendCommand } from './utils'; +import { VERSION } from './version'; + +export class IORedisInstrumentation extends InstrumentationBase< + typeof ioredisTypes +> { + static readonly DB_SYSTEM = 'redis'; + readonly supportedVersions = ['>1 <5']; + + constructor(protected _config: IORedisInstrumentationConfig = {}) { + super('@opentelemetry/instrumentation-ioredis', VERSION, _config); + } + + public setConfig( + config: IORedisInstrumentationConfig & InstrumentationConfig = {} + ) { + this._config = Object.assign({}, config); + } + + init(): InstrumentationNodeModuleDefinition[] { + return [ + new InstrumentationNodeModuleDefinition( + 'ioredis', + this.supportedVersions, + moduleExports => { + this._logger.debug('Applying patch for ioredis'); + if (isWrapped(moduleExports.prototype.sendCommand)) { + this._unwrap(moduleExports.prototype, 'sendCommand'); + } + this._wrap( + moduleExports.prototype, + 'sendCommand', + this._patchSendCommand() + ); + if (isWrapped(moduleExports.prototype.connect)) { + this._unwrap(moduleExports.prototype, 'connect'); + } + this._wrap( + moduleExports.prototype, + 'connect', + this._patchConnection() + ); + return moduleExports; + }, + moduleExports => { + if (moduleExports === undefined) return; + this._logger.debug('Removing patch for ioredis'); + this._unwrap(moduleExports.prototype, 'sendCommand'); + this._unwrap(moduleExports.prototype, 'connect'); + } + ), + ]; + } + + /** + * Patch send command internal to trace requests + */ + private _patchSendCommand() { + return (original: Function) => { + return traceSendCommand(this.tracer, original, this._config); + }; + } + + private _patchConnection() { + return (original: Function) => { + return traceConnection(this.tracer, original); + }; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts new file mode 100644 index 0000000000..738542c7b3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts @@ -0,0 +1,48 @@ +/* + * 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 type * as ioredisTypes from 'ioredis'; +import { InstrumentationConfig } from '@opentelemetry/instrumentation'; + +export interface IoredisCommand { + reject: (err: Error) => void; + resolve: (result: {}) => void; + promise: Promise<{}>; + args: Array; + callback: ioredisTypes.CallbackFunction; + name: string; +} + +/** + * Function that can be used to serialize db.statement tag + * @param cmdName - The name of the command (eg. set, get, mset) + * @param cmdArgs - Array of arguments passed to the command + * + * @returns serialized string that will be used as the db.statement attribute. + */ +export type DbStatementSerializer = ( + cmdName: IoredisCommand['name'], + cmdArgs: IoredisCommand['args'] +) => string; + +/** + * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options)) + */ +// eslint-disable-next-line @typescript-eslint/interface-name-prefix +export interface IORedisInstrumentationConfig extends InstrumentationConfig { + /** Custom serializer function for the db.statement tag */ + dbStatementSerializer?: DbStatementSerializer; +} diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts new file mode 100644 index 0000000000..50b7031232 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts @@ -0,0 +1,119 @@ +/* + * 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 type * as ioredisTypes from 'ioredis'; +import { Tracer, SpanKind, Span, StatusCode } from '@opentelemetry/api'; +import { + IoredisCommand, + IORedisInstrumentationConfig, + DbStatementSerializer, +} from './types'; +import { IORedisInstrumentation } from './ioredis'; +import { + DatabaseAttribute, + GeneralAttribute, +} from '@opentelemetry/semantic-conventions'; + +const endSpan = (span: Span, err: NodeJS.ErrnoException | null | undefined) => { + if (err) { + span.setStatus({ + code: StatusCode.ERROR, + message: err.message, + }); + } + span.end(); +}; + +export const traceConnection = (tracer: Tracer, original: Function) => { + return function (this: ioredisTypes.Redis) { + const span = tracer.startSpan('connect', { + kind: SpanKind.CLIENT, + attributes: { + [DatabaseAttribute.DB_SYSTEM]: IORedisInstrumentation.DB_SYSTEM, + [DatabaseAttribute.DB_STATEMENT]: 'connect', + }, + }); + const { host, port } = this.options; + + span.setAttributes({ + [GeneralAttribute.NET_PEER_NAME]: host, + [GeneralAttribute.NET_PEER_PORT]: port, + [GeneralAttribute.NET_PEER_ADDRESS]: `redis://${host}:${port}`, + }); + try { + const client = original.apply(this, arguments); + endSpan(span, null); + return client; + } catch (error) { + endSpan(span, error); + throw error; + } + }; +}; + +const defaultDbStatementSerializer: DbStatementSerializer = ( + cmdName, + cmdArgs +) => + Array.isArray(cmdArgs) && cmdArgs.length + ? `${cmdName} ${cmdArgs.join(' ')}` + : cmdName; + +export const traceSendCommand = ( + tracer: Tracer, + original: Function, + config?: IORedisInstrumentationConfig +) => { + const dbStatementSerializer = + config?.dbStatementSerializer || defaultDbStatementSerializer; + return function (this: ioredisTypes.Redis, cmd?: IoredisCommand) { + if (arguments.length < 1 || typeof cmd !== 'object') { + return original.apply(this, arguments); + } + // Do not trace if there is not parent span + if (tracer.getCurrentSpan() === undefined) { + return original.apply(this, arguments); + } + + const span = tracer.startSpan(cmd.name, { + kind: SpanKind.CLIENT, + attributes: { + [DatabaseAttribute.DB_SYSTEM]: IORedisInstrumentation.DB_SYSTEM, + [DatabaseAttribute.DB_STATEMENT]: dbStatementSerializer( + cmd.name, + cmd.args + ), + }, + }); + + const { host, port } = this.options; + + span.setAttributes({ + [GeneralAttribute.NET_PEER_NAME]: host, + [GeneralAttribute.NET_PEER_PORT]: port, + [GeneralAttribute.NET_PEER_ADDRESS]: `redis://${host}:${port}`, + }); + + try { + const result = original.apply(this, arguments); + endSpan(span, null); + return result; + } catch (error) { + endSpan(span, error); + throw error; + } + }; +}; diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts new file mode 100644 index 0000000000..707690f363 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/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.12.0'; diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts new file mode 100644 index 0000000000..140ab46bcb --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts @@ -0,0 +1,627 @@ +/* + * 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 { StatusCode, context, SpanKind, Status } from '@opentelemetry/api'; +import { NodeTracerProvider } from '@opentelemetry/node'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import * as testUtils from '@opentelemetry/test-utils'; +import { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/tracing'; +import * as assert from 'assert'; +import * as ioredisTypes from 'ioredis'; +import { IORedisInstrumentation } from '../src'; +import { + IORedisInstrumentationConfig, + DbStatementSerializer, +} from '../src/types'; +import { + DatabaseAttribute, + GeneralAttribute, +} from '@opentelemetry/semantic-conventions'; + +const memoryExporter = new InMemorySpanExporter(); + +const CONFIG = { + host: process.env.OPENTELEMETRY_REDIS_HOST || 'localhost', + port: parseInt(process.env.OPENTELEMETRY_REDIS_PORT || '63790', 10), +}; + +const URL = `redis://${CONFIG.host}:${CONFIG.port}`; + +const DEFAULT_ATTRIBUTES = { + [DatabaseAttribute.DB_SYSTEM]: IORedisInstrumentation.DB_SYSTEM, + [GeneralAttribute.NET_PEER_NAME]: CONFIG.host, + [GeneralAttribute.NET_PEER_PORT]: CONFIG.port, + [GeneralAttribute.NET_PEER_ADDRESS]: URL, +}; + +const unsetStatus: Status = { + code: StatusCode.UNSET, +}; + +describe('ioredis', () => { + const provider = new NodeTracerProvider(); + let ioredis: typeof ioredisTypes; + let instrumentation: IORedisInstrumentation; + const shouldTestLocal = process.env.RUN_REDIS_TESTS_LOCAL; + const shouldTest = process.env.RUN_REDIS_TESTS || shouldTestLocal; + + let contextManager: AsyncHooksContextManager; + beforeEach(() => { + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); + }); + + afterEach(() => { + context.disable(); + }); + + before(function () { + // needs to be "function" to have MochaContext "this" context + if (!shouldTest) { + // this.skip() workaround + // https://github.com/mochajs/mocha/issues/2683#issuecomment-375629901 + this.test!.parent!.pending = true; + this.skip(); + } + + if (shouldTestLocal) { + testUtils.startDocker('redis'); + } + + provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter)); + instrumentation = new IORedisInstrumentation(); + instrumentation.setTracerProvider(provider); + ioredis = require('ioredis'); + }); + + after(() => { + if (shouldTestLocal) { + testUtils.cleanUpDocker('redis'); + } + }); + + it('should have correct module name', () => { + assert.strictEqual( + instrumentation.instrumentationName, + '@opentelemetry/instrumentation-ioredis' + ); + }); + + describe('#createClient()', () => { + it('should propagate the current span to event handlers', done => { + const span = provider.getTracer('ioredis-test').startSpan('test span'); + let client: ioredisTypes.Redis; + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'connect', + }; + const readyHandler = () => { + const endedSpans = memoryExporter.getFinishedSpans(); + + assert.strictEqual( + provider.getTracer('ioredis-test').getCurrentSpan(), + span + ); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, 'connect'); + assert.strictEqual(endedSpans[1].name, 'info'); + testUtils.assertPropagation(endedSpans[0], span); + + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + span.end(); + assert.strictEqual(endedSpans.length, 3); + assert.strictEqual(endedSpans[2].name, 'test span'); + + client.quit(done); + assert.strictEqual(endedSpans.length, 4); + assert.strictEqual(endedSpans[3].name, 'quit'); + }; + const errorHandler = (err: Error) => { + assert.ifError(err); + client.quit(done); + }; + + provider.getTracer('ioredis-test').withSpan(span, () => { + client = new ioredis(URL); + client.on('ready', readyHandler); + client.on('error', errorHandler); + }); + }); + }); + + describe('#send_internal_message()', () => { + let client: ioredisTypes.Redis; + + const IOREDIS_CALLBACK_OPERATIONS: Array<{ + description: string; + name: string; + args: Array; + method: (cb: ioredisTypes.CallbackFunction) => unknown; + }> = [ + { + description: 'insert', + name: 'hset', + args: ['hash', 'testField', 'testValue'], + method: (cb: ioredisTypes.CallbackFunction) => + client.hset('hash', 'testField', 'testValue', cb), + }, + { + description: 'get', + name: 'get', + args: ['test'], + method: (cb: ioredisTypes.CallbackFunction) => + client.get('test', cb), + }, + ]; + + before(done => { + client = new ioredis(URL); + client.on('error', err => { + done(err); + }); + client.on('ready', done); + }); + + beforeEach(async () => { + await client.set('test', 'data'); + memoryExporter.reset(); + }); + + after(done => { + client.quit(done); + }); + + afterEach(async () => { + client.del('hash'); + memoryExporter.reset(); + }); + + describe('Instrumenting query operations', () => { + IOREDIS_CALLBACK_OPERATIONS.forEach(command => { + it(`should create a child span for cb style ${command.description}`, done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: `${ + command.name + } ${command.args.join(' ')}`, + }; + const span = provider + .getTracer('ioredis-test') + .startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + command.method((err, _result) => { + assert.ifError(err); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, command.name); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); + }); + }); + }); + + it('should create a child span for hset promise', async () => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'hset hash random random', + }; + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await provider.getTracer('ioredis-test').withSpan(span, async () => { + try { + await client.hset('hash', 'random', 'random'); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, 'hset'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + } catch (error) { + assert.ifError(error); + } + }); + }); + + it('should create a child span for streamify scanning', done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'scan 0', + }; + const span = provider.getTracer('ioredis-test').startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + const stream = client.scanStream(); + stream + .on('data', resultKeys => { + // `resultKeys` is an array of strings representing key names. + // Note that resultKeys may contain 0 keys, and that it will sometimes + // contain duplicates due to SCAN's implementation in Redis. + for (let i = 0; i < resultKeys.length; i++) { + console.log(resultKeys[i]); + } + }) + .on('end', () => { + console.log('all keys have been visited'); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, 'scan'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }) + .on('error', err => { + done(err); + }); + }); + }); + + it('should create a child span for pubsub', async () => { + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await provider.getTracer('ioredis-test').withSpan(span, async () => { + try { + const pub = new ioredis(URL); + const sub = new ioredis(URL); + await sub.subscribe('news', 'music'); + await pub.publish('news', 'Hello world!'); + await pub.publish('music', 'Hello again!'); + await sub.unsubscribe('news', 'music'); + await sub.quit(); + await pub.quit(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 11); + span.end(); + assert.strictEqual(endedSpans.length, 12); + const spanNames = [ + 'connect', + 'connect', + 'subscribe', + 'info', + 'info', + 'subscribe', + 'publish', + 'publish', + 'unsubscribe', + 'quit', + 'quit', + 'test span', + ]; + let i = 0; + while (i < 12) { + assert.strictEqual(endedSpans[i].name, spanNames[i]); + i++; + } + + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'subscribe news music', + }; + testUtils.assertSpan( + endedSpans[5], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + } catch (error) { + assert.ifError(error); + } + }); + }); + + it('should create a child span for lua', done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: + 'evalsha bfbf458525d6a0b19200bfd6db3af481156b367b 1 test', + }; + + const span = provider.getTracer('ioredis-test').startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + // This will define a command echo: + client.defineCommand('echo', { + numberOfKeys: 1, + lua: 'return {KEYS[1],ARGV[1]}', + }); + // Now `echo` can be used just like any other ordinary command, + // and ioredis will try to use `EVALSHA` internally when possible for better performance. + client.echo('test', (err, result) => { + assert.ifError(err); + + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 3); + assert.strictEqual(endedSpans[2].name, 'test span'); + assert.strictEqual(endedSpans[1].name, 'eval'); + assert.strictEqual(endedSpans[0].name, 'evalsha'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); + }); + }); + + it('should create a child span for multi/transaction', done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'multi', + }; + + const span = provider.getTracer('ioredis-test').startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + client + .multi() + .set('foo', 'bar') + .get('foo') + .exec((err, _results) => { + assert.ifError(err); + + assert.strictEqual(memoryExporter.getFinishedSpans().length, 4); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 5); + assert.strictEqual(endedSpans[0].name, 'multi'); + assert.strictEqual(endedSpans[1].name, 'set'); + assert.strictEqual(endedSpans[2].name, 'get'); + assert.strictEqual(endedSpans[3].name, 'exec'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); + }); + }); + + it('should create a child span for pipeline', done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'set foo bar', + }; + + const span = provider.getTracer('ioredis-test').startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + const pipeline = client.pipeline(); + pipeline.set('foo', 'bar'); + pipeline.del('cc'); + pipeline.exec((err, results) => { + assert.ifError(err); + + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 3); + assert.strictEqual(endedSpans[0].name, 'set'); + assert.strictEqual(endedSpans[1].name, 'del'); + assert.strictEqual(endedSpans[2].name, 'test span'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); + }); + }); + + it('should create a child span for get promise', async () => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'get test', + }; + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await provider.getTracer('ioredis-test').withSpan(span, async () => { + try { + const value = await client.get('test'); + assert.strictEqual(value, 'data'); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, 'get'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + } catch (error) { + assert.ifError(error); + } + }); + }); + + it('should create a child span for del', async () => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: 'del test', + }; + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await provider.getTracer('ioredis-test').withSpan(span, async () => { + try { + const result = await client.del('test'); + assert.strictEqual(result, 1); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, 'del'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + } catch (error) { + assert.ifError(error); + } + }); + }); + }); + + describe('Instrumenting without parent span', () => { + before(() => { + instrumentation.disable(); + instrumentation.enable(); + }); + it('should not create child span', async () => { + await client.set('test', 'data'); + const result = await client.del('test'); + assert.strictEqual(result, 1); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); + }); + + describe('Instrumenting with a custom db.statement serializer', () => { + const dbStatementSerializer: DbStatementSerializer = (cmdName, cmdArgs) => + `FOOBAR_${cmdName}: ${cmdArgs[0]}`; + before(() => { + instrumentation.disable(); + const config: IORedisInstrumentationConfig = { + dbStatementSerializer, + }; + instrumentation = new IORedisInstrumentation(config); + instrumentation.setTracerProvider(provider); + require('ioredis'); + }); + + IOREDIS_CALLBACK_OPERATIONS.forEach(command => { + it(`should tag the span with a custom db.statement for cb style ${command.description}`, done => { + const attributes = { + ...DEFAULT_ATTRIBUTES, + [DatabaseAttribute.DB_STATEMENT]: dbStatementSerializer( + command.name, + command.args + ), + }; + const span = provider + .getTracer('ioredis-test') + .startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + command.method((err, _result) => { + assert.ifError(err); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[0].name, command.name); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); + }); + }); + }); + }); + + describe('Removing instrumentation', () => { + before(() => { + instrumentation.disable(); + }); + + IOREDIS_CALLBACK_OPERATIONS.forEach(operation => { + it(`should not create a child span for cb style ${operation.description}`, done => { + const span = provider + .getTracer('ioredis-test') + .startSpan('test span'); + provider.getTracer('ioredis-test').withSpan(span, () => { + operation.method((err, _) => { + assert.ifError(err); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 1); + assert.strictEqual(endedSpans[0], span); + done(); + }); + }); + }); + }); + + it('should not create a child span for hset promise upon error', async () => { + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await provider.getTracer('ioredis-test').withSpan(span, async () => { + try { + await client.hset('hash', 'random', 'random'); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 1); + assert.strictEqual(endedSpans[0].name, 'test span'); + } catch (error) { + assert.ifError(error); + } + }); + }); + }); + }); +}); diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/tsconfig.json b/plugins/node/opentelemetry-instrumentation-ioredis/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-ioredis/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} From 95968275062c79c2f0b930fab3d7fc81742c4ae9 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Tue, 12 Jan 2021 20:42:03 +0100 Subject: [PATCH 02/14] fix: clear redis script cache after lua test --- .../test/ioredis.test.ts | 36 ++++++++++--------- .../test/ioredis.test.ts | 36 ++++++++++--------- 2 files changed, 40 insertions(+), 32 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts index 140ab46bcb..fad95bec46 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts @@ -372,23 +372,27 @@ describe('ioredis', () => { // and ioredis will try to use `EVALSHA` internally when possible for better performance. client.echo('test', (err, result) => { assert.ifError(err); + client.script('flush', (err, result) => { + assert.ifError(err); - assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); - span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual(endedSpans.length, 3); - assert.strictEqual(endedSpans[2].name, 'test span'); - assert.strictEqual(endedSpans[1].name, 'eval'); - assert.strictEqual(endedSpans[0].name, 'evalsha'); - testUtils.assertSpan( - endedSpans[0], - SpanKind.CLIENT, - attributes, - [], - unsetStatus - ); - testUtils.assertPropagation(endedSpans[0], span); - done(); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 3); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 4); + assert.strictEqual(endedSpans[3].name, 'test span'); + assert.strictEqual(endedSpans[2].name, 'script'); + assert.strictEqual(endedSpans[1].name, 'eval'); + assert.strictEqual(endedSpans[0].name, 'evalsha'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); }); }); }); diff --git a/plugins/node/opentelemetry-plugin-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-plugin-ioredis/test/ioredis.test.ts index 6cedb6a763..f6e6caf684 100644 --- a/plugins/node/opentelemetry-plugin-ioredis/test/ioredis.test.ts +++ b/plugins/node/opentelemetry-plugin-ioredis/test/ioredis.test.ts @@ -366,22 +366,26 @@ describe('ioredis', () => { client.echo('test', (err, result) => { assert.ifError(err); - assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); - span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual(endedSpans.length, 3); - assert.strictEqual(endedSpans[2].name, 'test span'); - assert.strictEqual(endedSpans[1].name, 'eval'); - assert.strictEqual(endedSpans[0].name, 'evalsha'); - testUtils.assertSpan( - endedSpans[0], - SpanKind.CLIENT, - attributes, - [], - unsetStatus - ); - testUtils.assertPropagation(endedSpans[0], span); - done(); + client.script('flush', (err, result) => { + assert.ifError(err); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 3); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 4); + assert.strictEqual(endedSpans[3].name, 'test span'); + assert.strictEqual(endedSpans[2].name, 'script'); + assert.strictEqual(endedSpans[1].name, 'eval'); + assert.strictEqual(endedSpans[0].name, 'evalsha'); + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); + }); }); }); }); From 5c8425b10e11dc1bd9f2af6072d3f837832f0944 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Wed, 13 Jan 2021 18:02:55 +0100 Subject: [PATCH 03/14] chore: export IORedisInstrumentationConfig --- plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts index 98bfff0f0d..1e4e8c2556 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/index.ts @@ -15,3 +15,4 @@ */ export * from './ioredis'; +export { IORedisInstrumentationConfig } from './types'; From 04f0296cab804f6ee7b2ed10a59435db17cc41c7 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Thu, 14 Jan 2021 14:00:42 +0100 Subject: [PATCH 04/14] chore: sync with plugin after merging master --- .../test/ioredis.test.ts | 78 ++++++++++--------- 1 file changed, 42 insertions(+), 36 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts index fad95bec46..9301171867 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts @@ -152,6 +152,11 @@ describe('ioredis', () => { }); describe('#send_internal_message()', () => { + // use a random part in key names because redis instance is used for parallel running tests + const randomId = ((Math.random() * 2 ** 32) >>> 0).toString(16); + const testKeyName = `test-${randomId}`; + const hashKeyName = `hash-${randomId}`; + let client: ioredisTypes.Redis; const IOREDIS_CALLBACK_OPERATIONS: Array<{ @@ -163,16 +168,16 @@ describe('ioredis', () => { { description: 'insert', name: 'hset', - args: ['hash', 'testField', 'testValue'], + args: [hashKeyName, 'testField', 'testValue'], method: (cb: ioredisTypes.CallbackFunction) => - client.hset('hash', 'testField', 'testValue', cb), + client.hset(hashKeyName, 'testField', 'testValue', cb), }, { description: 'get', name: 'get', - args: ['test'], + args: [testKeyName], method: (cb: ioredisTypes.CallbackFunction) => - client.get('test', cb), + client.get(testKeyName, cb), }, ]; @@ -185,7 +190,7 @@ describe('ioredis', () => { }); beforeEach(async () => { - await client.set('test', 'data'); + await client.set(testKeyName, 'data'); memoryExporter.reset(); }); @@ -194,7 +199,8 @@ describe('ioredis', () => { }); afterEach(async () => { - client.del('hash'); + await client.del(hashKeyName); + await client.del(testKeyName); memoryExporter.reset(); }); @@ -235,12 +241,12 @@ describe('ioredis', () => { it('should create a child span for hset promise', async () => { const attributes = { ...DEFAULT_ATTRIBUTES, - [DatabaseAttribute.DB_STATEMENT]: 'hset hash random random', + [DatabaseAttribute.DB_STATEMENT]: `hset ${hashKeyName} random random`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); await provider.getTracer('ioredis-test').withSpan(span, async () => { try { - await client.hset('hash', 'random', 'random'); + await client.hset(hashKeyName, 'random', 'random'); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); span.end(); const endedSpans = memoryExporter.getFinishedSpans(); @@ -357,8 +363,7 @@ describe('ioredis', () => { it('should create a child span for lua', done => { const attributes = { ...DEFAULT_ATTRIBUTES, - [DatabaseAttribute.DB_STATEMENT]: - 'evalsha bfbf458525d6a0b19200bfd6db3af481156b367b 1 test', + [DatabaseAttribute.DB_STATEMENT]: `evalsha bfbf458525d6a0b19200bfd6db3af481156b367b 1 ${testKeyName}`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); @@ -370,29 +375,30 @@ describe('ioredis', () => { }); // Now `echo` can be used just like any other ordinary command, // and ioredis will try to use `EVALSHA` internally when possible for better performance. - client.echo('test', (err, result) => { + client.echo(testKeyName, (err, result) => { assert.ifError(err); - client.script('flush', (err, result) => { - assert.ifError(err); - assert.strictEqual(memoryExporter.getFinishedSpans().length, 3); - span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual(endedSpans.length, 4); - assert.strictEqual(endedSpans[3].name, 'test span'); - assert.strictEqual(endedSpans[2].name, 'script'); + span.end(); + const endedSpans = memoryExporter.getFinishedSpans(); + // the script may be already cached on server therefore we get either 2 or 3 spans + if (endedSpans.length === 3) { + assert.strictEqual(endedSpans[2].name, 'test span'); assert.strictEqual(endedSpans[1].name, 'eval'); assert.strictEqual(endedSpans[0].name, 'evalsha'); - testUtils.assertSpan( - endedSpans[0], - SpanKind.CLIENT, - attributes, - [], - unsetStatus - ); - testUtils.assertPropagation(endedSpans[0], span); - done(); - }); + } else { + assert.strictEqual(endedSpans.length, 2); + assert.strictEqual(endedSpans[1].name, 'test span'); + assert.strictEqual(endedSpans[0].name, 'evalsha'); + } + testUtils.assertSpan( + endedSpans[0], + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); + testUtils.assertPropagation(endedSpans[0], span); + done(); }); }); }); @@ -470,12 +476,12 @@ describe('ioredis', () => { it('should create a child span for get promise', async () => { const attributes = { ...DEFAULT_ATTRIBUTES, - [DatabaseAttribute.DB_STATEMENT]: 'get test', + [DatabaseAttribute.DB_STATEMENT]: `get ${testKeyName}`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); await provider.getTracer('ioredis-test').withSpan(span, async () => { try { - const value = await client.get('test'); + const value = await client.get(testKeyName); assert.strictEqual(value, 'data'); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); span.end(); @@ -499,12 +505,12 @@ describe('ioredis', () => { it('should create a child span for del', async () => { const attributes = { ...DEFAULT_ATTRIBUTES, - [DatabaseAttribute.DB_STATEMENT]: 'del test', + [DatabaseAttribute.DB_STATEMENT]: `del ${testKeyName}`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); await provider.getTracer('ioredis-test').withSpan(span, async () => { try { - const result = await client.del('test'); + const result = await client.del(testKeyName); assert.strictEqual(result, 1); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); span.end(); @@ -532,8 +538,8 @@ describe('ioredis', () => { instrumentation.enable(); }); it('should not create child span', async () => { - await client.set('test', 'data'); - const result = await client.del('test'); + await client.set(testKeyName, 'data'); + const result = await client.del(testKeyName); assert.strictEqual(result, 1); assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); }); @@ -615,7 +621,7 @@ describe('ioredis', () => { const span = provider.getTracer('ioredis-test').startSpan('test span'); await provider.getTracer('ioredis-test').withSpan(span, async () => { try { - await client.hset('hash', 'random', 'random'); + await client.hset(hashKeyName, 'random', 'random'); assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); span.end(); const endedSpans = memoryExporter.getFinishedSpans(); From 8932fcf57cf8ab61382f474a1986b9d53cc9eb7d Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Thu, 14 Jan 2021 17:48:10 +0100 Subject: [PATCH 05/14] remove setConfig --- .../opentelemetry-instrumentation-ioredis/src/ioredis.ts | 7 ------- 1 file changed, 7 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts index bebe026cd4..4ab9f98e35 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts @@ -17,7 +17,6 @@ import type * as ioredisTypes from 'ioredis'; import { InstrumentationBase, - InstrumentationConfig, InstrumentationNodeModuleDefinition, isWrapped, } from '@opentelemetry/instrumentation'; @@ -35,12 +34,6 @@ export class IORedisInstrumentation extends InstrumentationBase< super('@opentelemetry/instrumentation-ioredis', VERSION, _config); } - public setConfig( - config: IORedisInstrumentationConfig & InstrumentationConfig = {} - ) { - this._config = Object.assign({}, config); - } - init(): InstrumentationNodeModuleDefinition[] { return [ new InstrumentationNodeModuleDefinition( From d371d77eedefdd87e5e0fa481589ce9e9732fd27 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Mon, 18 Jan 2021 11:15:19 +0100 Subject: [PATCH 06/14] chore: update links --- .../README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/README.md b/plugins/node/opentelemetry-instrumentation-ioredis/README.md index f95242c9c8..f08f900dfd 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/README.md +++ b/plugins/node/opentelemetry-instrumentation-ioredis/README.md @@ -17,7 +17,8 @@ npm install --save @opentelemetry/instrumentation-ioredis ``` ### Supported Versions - - `>=2.0.0` + +- `>=2.0.0` ## Usage @@ -77,11 +78,11 @@ const ioredisInstrumentation = new IORedisInstrumentation({ Apache 2.0 - See [LICENSE][license-url] for more information. -[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js-contrib.svg [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-instrumentation-ioredis -[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-ioredis -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-instrumentation-ioredis -[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-ioredis&type=dev +[dependencies-image]: https://david-dm.org/open-telemetryopentelemetry-js-contrib/status.svg?path=packages/opentelemetry-instrumentation-ioredis +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-instrumentation-ioredis +[devDependencies-image]: https://david-dm.org/open-telemetryopentelemetry-js-contrib/dev-status.svg?path=packages/opentelemetry-instrumentation-ioredis +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-instrumentation-ioredis&type=dev From ad016e3f24ab10b162af015528afc9c512aebfed Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Wed, 20 Jan 2021 19:56:59 +0100 Subject: [PATCH 07/14] chore: correct dependencies --- .../node/opentelemetry-instrumentation-ioredis/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index 076d3bce48..f214feb66c 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -46,7 +46,6 @@ "devDependencies": { "@opentelemetry/context-async-hooks": "^0.14.0", "@opentelemetry/node": "^0.14.0", - "@opentelemetry/semantic-conventions": "^0.14.0", "@opentelemetry/test-utils": "^0.12.0", "@opentelemetry/tracing": "^0.14.0", "@types/ioredis": "4.17.3", @@ -68,6 +67,7 @@ }, "dependencies": { "@opentelemetry/api": "^0.14.0", - "@opentelemetry/instrumentation": "^0.14.0" + "@opentelemetry/instrumentation": "^0.14.0", + "@opentelemetry/semantic-conventions": "^0.14.0" } } From 3340a7366be8f5621cbcb20dc0d27b4fcfa41dab Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Fri, 22 Jan 2021 20:09:21 +0100 Subject: [PATCH 08/14] chore: move to otel 0.15.0 --- .../package.json | 12 +++--- .../src/utils.ts | 11 ++++- .../test/ioredis.test.ts | 40 ++++++++++--------- 3 files changed, 37 insertions(+), 26 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index f214feb66c..ee79c88254 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -44,10 +44,10 @@ "access": "public" }, "devDependencies": { - "@opentelemetry/context-async-hooks": "^0.14.0", - "@opentelemetry/node": "^0.14.0", + "@opentelemetry/context-async-hooks": "^0.15.0", + "@opentelemetry/node": "^0.15.0", "@opentelemetry/test-utils": "^0.12.0", - "@opentelemetry/tracing": "^0.14.0", + "@opentelemetry/tracing": "^0.15.0", "@types/ioredis": "4.17.3", "@types/mocha": "7.0.2", "@types/node": "14.0.27", @@ -66,8 +66,8 @@ "typescript": "3.9.7" }, "dependencies": { - "@opentelemetry/api": "^0.14.0", - "@opentelemetry/instrumentation": "^0.14.0", - "@opentelemetry/semantic-conventions": "^0.14.0" + "@opentelemetry/api": "^0.15.0", + "@opentelemetry/instrumentation": "^0.15.0", + "@opentelemetry/semantic-conventions": "^0.15.0" } } diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts index 50b7031232..99c189b81d 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts @@ -15,7 +15,14 @@ */ import type * as ioredisTypes from 'ioredis'; -import { Tracer, SpanKind, Span, StatusCode } from '@opentelemetry/api'; +import { + Tracer, + SpanKind, + Span, + StatusCode, + getSpan, + context, +} from '@opentelemetry/api'; import { IoredisCommand, IORedisInstrumentationConfig, @@ -84,7 +91,7 @@ export const traceSendCommand = ( return original.apply(this, arguments); } // Do not trace if there is not parent span - if (tracer.getCurrentSpan() === undefined) { + if (getSpan(context.active()) === undefined) { return original.apply(this, arguments); } diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts index 9301171867..68fa0fc891 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts @@ -14,7 +14,14 @@ * limitations under the License. */ -import { StatusCode, context, SpanKind, Status } from '@opentelemetry/api'; +import { + StatusCode, + context, + SpanKind, + Status, + getSpan, + setSpan, +} from '@opentelemetry/api'; import { NodeTracerProvider } from '@opentelemetry/node'; import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; @@ -114,10 +121,7 @@ describe('ioredis', () => { const readyHandler = () => { const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual( - provider.getTracer('ioredis-test').getCurrentSpan(), - span - ); + assert.strictEqual(getSpan(context.active()), span); assert.strictEqual(endedSpans.length, 2); assert.strictEqual(endedSpans[0].name, 'connect'); assert.strictEqual(endedSpans[1].name, 'info'); @@ -143,7 +147,7 @@ describe('ioredis', () => { client.quit(done); }; - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { client = new ioredis(URL); client.on('ready', readyHandler); client.on('error', errorHandler); @@ -216,7 +220,7 @@ describe('ioredis', () => { const span = provider .getTracer('ioredis-test') .startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { command.method((err, _result) => { assert.ifError(err); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); @@ -244,7 +248,7 @@ describe('ioredis', () => { [DatabaseAttribute.DB_STATEMENT]: `hset ${hashKeyName} random random`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - await provider.getTracer('ioredis-test').withSpan(span, async () => { + await context.with(setSpan(context.active(), span), async () => { try { await client.hset(hashKeyName, 'random', 'random'); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); @@ -272,7 +276,7 @@ describe('ioredis', () => { [DatabaseAttribute.DB_STATEMENT]: 'scan 0', }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { const stream = client.scanStream(); stream .on('data', resultKeys => { @@ -308,7 +312,7 @@ describe('ioredis', () => { it('should create a child span for pubsub', async () => { const span = provider.getTracer('ioredis-test').startSpan('test span'); - await provider.getTracer('ioredis-test').withSpan(span, async () => { + await context.with(setSpan(context.active(), span), async () => { try { const pub = new ioredis(URL); const sub = new ioredis(URL); @@ -367,7 +371,7 @@ describe('ioredis', () => { }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { // This will define a command echo: client.defineCommand('echo', { numberOfKeys: 1, @@ -410,7 +414,7 @@ describe('ioredis', () => { }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { client .multi() .set('foo', 'bar') @@ -446,7 +450,7 @@ describe('ioredis', () => { }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { const pipeline = client.pipeline(); pipeline.set('foo', 'bar'); pipeline.del('cc'); @@ -479,7 +483,7 @@ describe('ioredis', () => { [DatabaseAttribute.DB_STATEMENT]: `get ${testKeyName}`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - await provider.getTracer('ioredis-test').withSpan(span, async () => { + await context.with(setSpan(context.active(), span), async () => { try { const value = await client.get(testKeyName); assert.strictEqual(value, 'data'); @@ -508,7 +512,7 @@ describe('ioredis', () => { [DatabaseAttribute.DB_STATEMENT]: `del ${testKeyName}`, }; const span = provider.getTracer('ioredis-test').startSpan('test span'); - await provider.getTracer('ioredis-test').withSpan(span, async () => { + await context.with(setSpan(context.active(), span), async () => { try { const result = await client.del(testKeyName); assert.strictEqual(result, 1); @@ -570,7 +574,7 @@ describe('ioredis', () => { const span = provider .getTracer('ioredis-test') .startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { command.method((err, _result) => { assert.ifError(err); assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); @@ -603,7 +607,7 @@ describe('ioredis', () => { const span = provider .getTracer('ioredis-test') .startSpan('test span'); - provider.getTracer('ioredis-test').withSpan(span, () => { + context.with(setSpan(context.active(), span), () => { operation.method((err, _) => { assert.ifError(err); assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); @@ -619,7 +623,7 @@ describe('ioredis', () => { it('should not create a child span for hset promise upon error', async () => { const span = provider.getTracer('ioredis-test').startSpan('test span'); - await provider.getTracer('ioredis-test').withSpan(span, async () => { + await context.with(setSpan(context.active(), span), async () => { try { await client.hset(hashKeyName, 'random', 'random'); assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); From 44981afd194ad180f67cecd43e993f2c3421d013 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Wed, 27 Jan 2021 23:42:05 +0100 Subject: [PATCH 09/14] chore: update version --- .../node/opentelemetry-instrumentation-ioredis/package.json | 4 ++-- .../node/opentelemetry-instrumentation-ioredis/src/version.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index ee79c88254..de8e53a67c 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/instrumentation-ioredis", - "version": "0.12.0", + "version": "0.12.1", "description": "OpenTelemetry ioredis automatic instrumentation package.", "main": "build/src/index.js", "types": "build/src/index.d.ts", @@ -46,7 +46,7 @@ "devDependencies": { "@opentelemetry/context-async-hooks": "^0.15.0", "@opentelemetry/node": "^0.15.0", - "@opentelemetry/test-utils": "^0.12.0", + "@opentelemetry/test-utils": "^0.12.1", "@opentelemetry/tracing": "^0.15.0", "@types/ioredis": "4.17.3", "@types/mocha": "7.0.2", diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts index 707690f363..c032ed99f3 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/version.ts @@ -15,4 +15,4 @@ */ // this is autogenerated file, see scripts/version-update.js -export const VERSION = '0.12.0'; +export const VERSION = '0.12.1'; From 7a5b0758ec79f478deba2102cb4ff805bfb1e455 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Thu, 28 Jan 2021 11:12:35 +0100 Subject: [PATCH 10/14] chore: more consistent type nameing --- .../node/opentelemetry-instrumentation-ioredis/src/types.ts | 6 +++--- .../node/opentelemetry-instrumentation-ioredis/src/utils.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts index 738542c7b3..55a9f09aef 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts @@ -17,7 +17,7 @@ import type * as ioredisTypes from 'ioredis'; import { InstrumentationConfig } from '@opentelemetry/instrumentation'; -export interface IoredisCommand { +export interface IORedisCommand { reject: (err: Error) => void; resolve: (result: {}) => void; promise: Promise<{}>; @@ -34,8 +34,8 @@ export interface IoredisCommand { * @returns serialized string that will be used as the db.statement attribute. */ export type DbStatementSerializer = ( - cmdName: IoredisCommand['name'], - cmdArgs: IoredisCommand['args'] + cmdName: IORedisCommand['name'], + cmdArgs: IORedisCommand['args'] ) => string; /** diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts index 99c189b81d..933c9266fb 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts @@ -24,7 +24,7 @@ import { context, } from '@opentelemetry/api'; import { - IoredisCommand, + IORedisCommand, IORedisInstrumentationConfig, DbStatementSerializer, } from './types'; @@ -86,7 +86,7 @@ export const traceSendCommand = ( ) => { const dbStatementSerializer = config?.dbStatementSerializer || defaultDbStatementSerializer; - return function (this: ioredisTypes.Redis, cmd?: IoredisCommand) { + return function (this: ioredisTypes.Redis, cmd?: IORedisCommand) { if (arguments.length < 1 || typeof cmd !== 'object') { return original.apply(this, arguments); } From aa7941de027fd66ec335c96dafe112afdb4bf2d8 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Thu, 28 Jan 2021 11:12:54 +0100 Subject: [PATCH 11/14] chore: update links --- plugins/node/opentelemetry-instrumentation-ioredis/README.md | 4 ++-- .../node/opentelemetry-instrumentation-ioredis/package.json | 2 +- .../node/opentelemetry-instrumentation-ioredis/src/types.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/README.md b/plugins/node/opentelemetry-instrumentation-ioredis/README.md index f08f900dfd..bb2f86d513 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/README.md +++ b/plugins/node/opentelemetry-instrumentation-ioredis/README.md @@ -8,7 +8,7 @@ This module provides automatic instrumentation for [`ioredis`](https://github.com/luin/ioredis). For automatic instrumentation see the -[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package. +[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. ## Installation @@ -80,7 +80,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js-contrib.svg [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [dependencies-image]: https://david-dm.org/open-telemetryopentelemetry-js-contrib/status.svg?path=packages/opentelemetry-instrumentation-ioredis [dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-instrumentation-ioredis diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index de8e53a67c..00bf4c27e0 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -4,7 +4,7 @@ "description": "OpenTelemetry ioredis automatic instrumentation package.", "main": "build/src/index.js", "types": "build/src/index.d.ts", - "repository": "open-telemetry/opentelemetry-js", + "repository": "open-telemetry/opentelemetry-js-contrib", "scripts": { "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", "test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true ts-mocha --inspect-brk --no-timeouts -p tsconfig.json 'test/**/*.test.ts'", diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts index 55a9f09aef..554ad032f0 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts @@ -39,7 +39,7 @@ export type DbStatementSerializer = ( ) => string; /** - * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options)) + * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options)) */ // eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface IORedisInstrumentationConfig extends InstrumentationConfig { From 207010ce5f411c8e5a5058784c122cfe81b15603 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Thu, 28 Jan 2021 11:22:09 +0100 Subject: [PATCH 12/14] chore: fix lint --- plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts index 554ad032f0..545fda0c31 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts @@ -17,6 +17,7 @@ import type * as ioredisTypes from 'ioredis'; import { InstrumentationConfig } from '@opentelemetry/instrumentation'; +// eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface IORedisCommand { reject: (err: Error) => void; resolve: (result: {}) => void; From afde5531dac594f527041d089f7fa92b4e57bb45 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Fri, 29 Jan 2021 08:54:13 +0100 Subject: [PATCH 13/14] chore: merge changes from #239 --- .../src/utils.ts | 16 ++- .../test/ioredis.test.ts | 98 ++++++++++++++++--- 2 files changed, 101 insertions(+), 13 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts index 933c9266fb..7955c3a55c 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts @@ -36,6 +36,7 @@ import { const endSpan = (span: Span, err: NodeJS.ErrnoException | null | undefined) => { if (err) { + span.recordException(err); span.setStatus({ code: StatusCode.ERROR, message: err.message, @@ -116,7 +117,20 @@ export const traceSendCommand = ( try { const result = original.apply(this, arguments); - endSpan(span, null); + + const origResolve = cmd.resolve; + /* eslint-disable @typescript-eslint/no-explicit-any */ + cmd.resolve = function (result: any) { + endSpan(span, null); + origResolve(result); + }; + + const origReject = cmd.reject; + cmd.reject = function (err: Error) { + endSpan(span, err); + origReject(err); + }; + return result; } catch (error) { endSpan(span, error); diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts index 68fa0fc891..80f15e1a8c 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts +++ b/plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts @@ -27,6 +27,7 @@ import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, + ReadableSpan, SimpleSpanProcessor, } from '@opentelemetry/tracing'; import * as assert from 'assert'; @@ -38,6 +39,7 @@ import { } from '../src/types'; import { DatabaseAttribute, + ExceptionAttribute, GeneralAttribute, } from '@opentelemetry/semantic-conventions'; @@ -61,6 +63,20 @@ const unsetStatus: Status = { code: StatusCode.UNSET, }; +const predictableStackTrace = + '-- Stack trace replaced by test to predictable value -- '; +const sanitizeEventForAssertion = (span: ReadableSpan) => { + span.events.forEach(e => { + // stack trace includes data such as /user/{userName}/repos/{projectName} + if (e.attributes?.[ExceptionAttribute.STACKTRACE]) { + e.attributes[ExceptionAttribute.STACKTRACE] = predictableStackTrace; + } + + // since time will change on each test invocation, it is being replaced to predicable value + e.time = [0, 0]; + }); +}; + describe('ioredis', () => { const provider = new NodeTracerProvider(); let ioredis: typeof ioredisTypes; @@ -138,9 +154,11 @@ describe('ioredis', () => { assert.strictEqual(endedSpans.length, 3); assert.strictEqual(endedSpans[2].name, 'test span'); - client.quit(done); - assert.strictEqual(endedSpans.length, 4); - assert.strictEqual(endedSpans[3].name, 'quit'); + client.quit(() => { + assert.strictEqual(endedSpans.length, 4); + assert.strictEqual(endedSpans[3].name, 'quit'); + done(); + }); }; const errorHandler = (err: Error) => { assert.ifError(err); @@ -270,6 +288,38 @@ describe('ioredis', () => { }); }); + it('should set span with error when redis return reject', async () => { + const span = provider.getTracer('ioredis-test').startSpan('test span'); + await context.with(setSpan(context.active(), span), async () => { + await client.set('non-int-key', 'non-int-value'); + try { + // should throw 'ReplyError: ERR value is not an integer or out of range' + // because the value im the key is not numeric and we try to increment it + await client.incr('non-int-key'); + } catch (ex) { + const endedSpans = memoryExporter.getFinishedSpans(); + assert.strictEqual(endedSpans.length, 2); + const ioredisSpan = endedSpans[1]; + // redis 'incr' operation failed with exception, so span should indicate it + assert.strictEqual(ioredisSpan.status.code, StatusCode.ERROR); + const exceptionEvent = ioredisSpan.events[0]; + assert.strictEqual(exceptionEvent.name, 'exception'); + assert.strictEqual( + exceptionEvent.attributes?.[ExceptionAttribute.MESSAGE], + ex.message + ); + assert.strictEqual( + exceptionEvent.attributes?.[ExceptionAttribute.STACKTRACE], + ex.stack + ); + assert.strictEqual( + exceptionEvent.attributes?.[ExceptionAttribute.TYPE], + ex.name + ); + } + }); + }); + it('should create a child span for streamify scanning', done => { const attributes = { ...DEFAULT_ATTRIBUTES, @@ -329,10 +379,10 @@ describe('ioredis', () => { const spanNames = [ 'connect', 'connect', - 'subscribe', 'info', 'info', 'subscribe', + 'subscribe', 'publish', 'publish', 'unsubscribe', @@ -384,24 +434,48 @@ describe('ioredis', () => { span.end(); const endedSpans = memoryExporter.getFinishedSpans(); + const evalshaSpan = endedSpans[0]; // the script may be already cached on server therefore we get either 2 or 3 spans if (endedSpans.length === 3) { assert.strictEqual(endedSpans[2].name, 'test span'); assert.strictEqual(endedSpans[1].name, 'eval'); assert.strictEqual(endedSpans[0].name, 'evalsha'); + // in this case, server returns NOSCRIPT error for evalsha, + // telling the client to use EVAL instead + sanitizeEventForAssertion(evalshaSpan); + testUtils.assertSpan( + evalshaSpan, + SpanKind.CLIENT, + attributes, + [ + { + attributes: { + [ExceptionAttribute.MESSAGE]: + 'NOSCRIPT No matching script. Please use EVAL.', + [ExceptionAttribute.STACKTRACE]: predictableStackTrace, + [ExceptionAttribute.TYPE]: 'ReplyError', + }, + name: 'exception', + time: [0, 0], + }, + ], + { + code: StatusCode.ERROR, + } + ); } else { assert.strictEqual(endedSpans.length, 2); assert.strictEqual(endedSpans[1].name, 'test span'); assert.strictEqual(endedSpans[0].name, 'evalsha'); + testUtils.assertSpan( + evalshaSpan, + SpanKind.CLIENT, + attributes, + [], + unsetStatus + ); } - testUtils.assertSpan( - endedSpans[0], - SpanKind.CLIENT, - attributes, - [], - unsetStatus - ); - testUtils.assertPropagation(endedSpans[0], span); + testUtils.assertPropagation(evalshaSpan, span); done(); }); }); From d4d5f5ac69949850aaa5c8e40d08b9431e16f6b8 Mon Sep 17 00:00:00 2001 From: Gerhard Stoebich <18708370+Flarna@users.noreply.github.com> Date: Mon, 1 Feb 2021 19:54:51 +0100 Subject: [PATCH 14/14] chore: move to 0.13.0 --- .../node/opentelemetry-instrumentation-ioredis/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index 00bf4c27e0..cef479fa50 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/plugins/node/opentelemetry-instrumentation-ioredis/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/instrumentation-ioredis", - "version": "0.12.1", + "version": "0.13.0", "description": "OpenTelemetry ioredis automatic instrumentation package.", "main": "build/src/index.js", "types": "build/src/index.d.ts", @@ -46,7 +46,7 @@ "devDependencies": { "@opentelemetry/context-async-hooks": "^0.15.0", "@opentelemetry/node": "^0.15.0", - "@opentelemetry/test-utils": "^0.12.1", + "@opentelemetry/test-utils": "^0.13.0", "@opentelemetry/tracing": "^0.15.0", "@types/ioredis": "4.17.3", "@types/mocha": "7.0.2",