From 5a7fcc84a0b54e342a4503509671429f6cfa3456 Mon Sep 17 00:00:00 2001 From: Rauno Viskus Date: Tue, 25 May 2021 19:10:35 +0300 Subject: [PATCH] feat: implement instrumentation for generic-pool (#489) Co-authored-by: Valentin Marchaud --- .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../.npmignore | 4 + .../LICENSE | 201 ++++++++++++++++++ .../README.md | 59 +++++ .../package.json | 66 ++++++ .../src/index.ts | 20 ++ .../src/instrumentation.ts | 187 ++++++++++++++++ .../src/version.ts | 18 ++ .../test/index.test.ts | 120 +++++++++++ .../tsconfig.json | 11 + 11 files changed, 694 insertions(+) create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/.eslintignore create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/.eslintrc.js create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/.npmignore create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/LICENSE create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/README.md create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/package.json create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/src/index.ts create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/src/version.ts create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/test/index.test.ts create mode 100644 plugins/node/opentelemetry-instrumentation-generic-pool/tsconfig.json diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintignore b/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintignore new file mode 100644 index 00000000000..378eac25d31 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintrc.js new file mode 100644 index 00000000000..f756f4488b2 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/.npmignore b/plugins/node/opentelemetry-instrumentation-generic-pool/.npmignore new file mode 100644 index 00000000000..9505ba9450f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/LICENSE b/plugins/node/opentelemetry-instrumentation-generic-pool/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/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-generic-pool/README.md b/plugins/node/opentelemetry-instrumentation-generic-pool/README.md new file mode 100644 index 00000000000..7e6ab5a152b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/README.md @@ -0,0 +1,59 @@ +# OpenTelemetry Generic Pool Instrumentation for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This module provides basic automatic instrumentation for [`generic-pool`](https://github.com/coopernurse/node-pool) creating a span for every acquire call. + +For automatic instrumentation see the +[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-generic-pool +``` +### Supported Versions + + - `>=2.0.0` + +## Usage + +```js +const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/tracing'); +const { NodeTracerProvider } = require('@opentelemetry/node'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); +const { GenericPoolInstrumentation } = require('@opentelemetry/instrumentation-generic-pool'); + +const provider = new NodeTracerProvider(); + +provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); +provider.register(); + +registerInstrumentations({ + instrumentations: [new GenericPoolInstrumentation()], + tracerProvider: provider, +}); +``` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-generic-pool +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-generic-pool +[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-generic-pool&type=dev +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-generic-pool&type=dev +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-generic-pool +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-generic-pool.svg diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/package.json b/plugins/node/opentelemetry-instrumentation-generic-pool/package.json new file mode 100644 index 00000000000..edc3a599189 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/package.json @@ -0,0 +1,66 @@ +{ + "name": "@opentelemetry/instrumentation-generic-pool", + "version": "0.16.0", + "description": "OpenTelemetry Generic Pool automatic instrumentation package", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "tdd": "yarn test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version", + "version:update": "node ../../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p .", + "prepare": "npm run compile", + "watch": "tsc -w" + }, + "keywords": [ + "opentelemetry", + "generic-pool", + "nodejs", + "tracing", + "instrumentation" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.5.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/context-async-hooks": "0.19.0", + "@opentelemetry/node": "0.19.0", + "@opentelemetry/tracing": "0.19.0", + "@types/mocha": "7.0.2", + "@types/node": "14.0.27", + "@types/semver": "^7.3.6", + "codecov": "3.7.2", + "generic-pool": "^3.7.8", + "gts": "3.1.0", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "semver": "^7.3.5", + "ts-mocha": "8.0.0", + "typescript": "4.1.3" + }, + "dependencies": { + "@opentelemetry/api": "1.0.0-rc.0", + "@opentelemetry/instrumentation": "^0.19.0", + "@opentelemetry/semantic-conventions": "^0.19.0", + "@types/generic-pool": "^3.1.9" + } +} diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/src/index.ts b/plugins/node/opentelemetry-instrumentation-generic-pool/src/index.ts new file mode 100644 index 00000000000..3b04638af8e --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/src/index.ts @@ -0,0 +1,20 @@ +/* + * 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 GenericPoolInstrumentation from './instrumentation'; + +export { GenericPoolInstrumentation }; +export default GenericPoolInstrumentation; diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts new file mode 100644 index 00000000000..6bf5646eda7 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts @@ -0,0 +1,187 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as api from '@opentelemetry/api'; +import { + InstrumentationBase, + InstrumentationNodeModuleDefinition, + isWrapped, +} from '@opentelemetry/instrumentation'; + +import type * as genericPool from 'generic-pool'; + +import { VERSION } from './version'; + +const MODULE_NAME = 'generic-pool'; + +export default class Instrumentation extends InstrumentationBase< + typeof genericPool +> { + // only used for v2 - v2.3) + private _isDisabled = false; + + constructor() { + super(`@opentelemetry/instrumentation-${MODULE_NAME}`, VERSION); + } + + init() { + return [ + new InstrumentationNodeModuleDefinition( + MODULE_NAME, + ['>=3'], + (moduleExports, moduleVersion) => { + api.diag.debug(`Applying patch for ${MODULE_NAME}@${moduleVersion}`); + const Pool: any = moduleExports.Pool; + if (isWrapped(Pool.prototype.acquire)) { + this._unwrap(Pool.prototype, 'acquire'); + } + this._wrap( + Pool.prototype, + 'acquire', + this._acquirePatcher.bind(this) + ); + return moduleExports; + }, + (moduleExports, moduleVersion) => { + api.diag.debug(`Removing patch for ${MODULE_NAME}@${moduleVersion}`); + const Pool: any = moduleExports.Pool; + this._unwrap(Pool.prototype, 'acquire'); + return moduleExports; + } + ), + new InstrumentationNodeModuleDefinition( + MODULE_NAME, + ['^2.4'], + (moduleExports, moduleVersion) => { + api.diag.debug(`Applying patch for ${MODULE_NAME}@${moduleVersion}`); + const Pool: any = moduleExports.Pool; + if (isWrapped(Pool.prototype.acquire)) { + this._unwrap(Pool.prototype, 'acquire'); + } + this._wrap( + Pool.prototype, + 'acquire', + this._acquireWithCallbacksPatcher.bind(this) + ); + return moduleExports; + }, + (moduleExports, moduleVersion) => { + api.diag.debug(`Removing patch for ${MODULE_NAME}@${moduleVersion}`); + const Pool: any = moduleExports.Pool; + this._unwrap(Pool.prototype, 'acquire'); + return moduleExports; + } + ), + new InstrumentationNodeModuleDefinition( + MODULE_NAME, + ['2 - 2.3'], + (moduleExports, moduleVersion) => { + api.diag.debug(`Applying patch for ${MODULE_NAME}@${moduleVersion}`); + this._isDisabled = false; + if (isWrapped(moduleExports.Pool)) { + this._unwrap(moduleExports, 'Pool'); + } + this._wrap(moduleExports, 'Pool', this._poolWrapper.bind(this)); + return moduleExports; + }, + (moduleExports, moduleVersion) => { + api.diag.debug(`Removing patch for ${MODULE_NAME}@${moduleVersion}`); + // since the object is created on the fly every time, we need to use + // a boolean switch here to disable the instrumentation + this._isDisabled = true; + return moduleExports; + } + ), + ]; + } + + private _acquirePatcher(original: genericPool.Pool['acquire']) { + const instrumentation = this; + return function wrapped_acquire( + this: genericPool.Pool, + ...args: any[] + ) { + const parent = api.context.active(); + const span = instrumentation.tracer.startSpan( + 'generic-pool.aquire', + {}, + parent + ); + + return api.context.with(api.setSpan(parent, span), () => { + return original.call(this, ...args).then( + value => { + span.end(); + return value; + }, + err => { + span.recordException(err); + span.end(); + throw err; + } + ); + }); + }; + } + + private _poolWrapper(original: any) { + const instrumentation = this; + return function wrapped_pool(this: any) { + const pool = original.apply(this, arguments); + instrumentation._wrap( + pool, + 'acquire', + instrumentation._acquireWithCallbacksPatcher.bind(instrumentation) + ); + return pool; + }; + } + + private _acquireWithCallbacksPatcher(original: any) { + const instrumentation = this; + return function wrapped_acquire( + this: genericPool.Pool, + cb: Function, + priority: number + ) { + // only used for v2 - v2.3 + if (instrumentation._isDisabled) { + return original.call(this, cb, priority); + } + const parent = api.context.active(); + const span = instrumentation.tracer.startSpan( + 'generic-pool.aquire', + {}, + parent + ); + + return api.context.with(api.setSpan(parent, span), () => { + original.call( + this, + (err: unknown, client: unknown) => { + span.end(); + // Not checking whether cb is a function because + // the original code doesn't do that either. + if (cb) { + return cb(err, client); + } + }, + priority + ); + }); + }; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/src/version.ts b/plugins/node/opentelemetry-instrumentation-generic-pool/src/version.ts new file mode 100644 index 00000000000..eacb17da857 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/src/version.ts @@ -0,0 +1,18 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.16.0'; diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/test/index.test.ts b/plugins/node/opentelemetry-instrumentation-generic-pool/test/index.test.ts new file mode 100644 index 00000000000..1902599e784 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/test/index.test.ts @@ -0,0 +1,120 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { context, setSpan } from '@opentelemetry/api'; +import { NodeTracerProvider } from '@opentelemetry/node'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/tracing'; + +import Instrumentation from '../src'; +const plugin = new Instrumentation(); + +import * as util from 'util'; +import * as genericPool from 'generic-pool'; +import * as assert from 'assert'; +import * as semver from 'semver'; + +const CLIENT = '_client_'; + +const version = require('generic-pool/package.json').version; +const isOldVersion = semver.satisfies(version, '2'); + +const createPool = { + v3: () => { + const pool = genericPool.createPool({ + create: () => { + return Promise.resolve(CLIENT); + }, + destroy: () => { + return Promise.resolve(); + }, + }); + return () => { + return pool.acquire(); + }; + }, + v2: () => { + const Pool: any = genericPool.Pool; + const pool = Pool({ + create: (cb: Function) => { + return cb(CLIENT); + }, + destroy: () => {}, + }); + return () => { + // We need to do that on the fly every time, because the instrumentation + // changes the prototype and thus the function as well. + const acquire = util.promisify(pool.acquire).bind(pool); + return acquire(); + }; + }, +}[isOldVersion ? 'v2' : 'v3']; + +describe('GenericPool instrumentation', () => { + const provider = new NodeTracerProvider(); + const memoryExporter = new InMemorySpanExporter(); + const spanProcessor = new SimpleSpanProcessor(memoryExporter); + provider.addSpanProcessor(spanProcessor); + plugin.setTracerProvider(provider); + const tracer = provider.getTracer('default'); + let contextManager: AsyncHooksContextManager; + let acquire: Function; + + beforeEach(async () => { + plugin.enable(); + acquire = createPool(); + contextManager = new AsyncHooksContextManager(); + context.setGlobalContextManager(contextManager.enable()); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); + + afterEach(() => { + memoryExporter.reset(); + context.disable(); + plugin.disable(); + }); + + it('should create a span for acquire', async () => { + assert.strictEqual(await acquire(), CLIENT); + const [span] = memoryExporter.getFinishedSpans(); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + assert.strictEqual(span.name, 'generic-pool.aquire'); + }); + + it('should attach it to the parent span', async () => { + const rootSpan: any = tracer.startSpan('clientSpan'); + + await context.with(setSpan(context.active(), rootSpan), async () => { + assert.strictEqual(await acquire(), CLIENT); + rootSpan.end(); + + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + + const [span] = memoryExporter.getFinishedSpans(); + assert.strictEqual(span.name, 'generic-pool.aquire'); + assert.strictEqual(span.parentSpanId, rootSpan.spanContext.spanId); + }); + }); + + it('should not create anything if disabled', async () => { + plugin.disable(); + assert.strictEqual(await acquire(), CLIENT); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); +}); diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/tsconfig.json b/plugins/node/opentelemetry-instrumentation-generic-pool/tsconfig.json new file mode 100644 index 00000000000..28be80d266c --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-generic-pool/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +}