From 3898b11800f857c75c286f22c4633b5baf4e1f84 Mon Sep 17 00:00:00 2001 From: Henri Normak Date: Tue, 27 Sep 2022 10:54:51 +0300 Subject: [PATCH] feat: add dataloader instrumentation (#1171) * feat: add dataloader instrumentation * fix: linter errors and a few mistypings * docs: add component_owners entry for dataloader instrumentation * fix: avoid double shimming of the batch load function * test: cover more lines in tests * refactor: remove prefix from directory name * feat: add configuration option for requiring parent span * chore: drop version number to 0.1.0 * chore: add dataloader instrumentation to release-please-config * feat: add dataloader instrumentation to auto-instrumentations-node * fix: use correct version of Node * fix: add missing export Also make instrumentation export explicit * test: adjust assertion to be correct * chore: change node types to be consistent with other plugins Co-authored-by: Rauno Viskus --- .github/component_owners.yml | 2 + .../auto-instrumentations-node/README.md | 1 + .../auto-instrumentations-node/package.json | 1 + .../auto-instrumentations-node/src/utils.ts | 2 + .../test/utils.test.ts | 3 +- .../instrumentation-dataloader/.eslintignore | 1 + .../instrumentation-dataloader/.eslintrc.js | 7 + .../instrumentation-dataloader/.npmignore | 4 + .../node/instrumentation-dataloader/.tav.yml | 4 + .../instrumentation-dataloader/CHANGELOG.md | 1 + .../node/instrumentation-dataloader/LICENSE | 201 ++++++++++++ .../node/instrumentation-dataloader/README.md | 70 +++++ .../instrumentation-dataloader/package.json | 68 +++++ .../instrumentation-dataloader/src/index.ts | 18 ++ .../src/instrumentation.ts | 248 +++++++++++++++ .../instrumentation-dataloader/src/types.ts | 26 ++ .../test/dataloader.test.ts | 287 ++++++++++++++++++ .../instrumentation-dataloader/tsconfig.json | 11 + release-please-config.json | 1 + 19 files changed, 955 insertions(+), 1 deletion(-) create mode 100644 plugins/node/instrumentation-dataloader/.eslintignore create mode 100644 plugins/node/instrumentation-dataloader/.eslintrc.js create mode 100644 plugins/node/instrumentation-dataloader/.npmignore create mode 100644 plugins/node/instrumentation-dataloader/.tav.yml create mode 100644 plugins/node/instrumentation-dataloader/CHANGELOG.md create mode 100644 plugins/node/instrumentation-dataloader/LICENSE create mode 100644 plugins/node/instrumentation-dataloader/README.md create mode 100644 plugins/node/instrumentation-dataloader/package.json create mode 100644 plugins/node/instrumentation-dataloader/src/index.ts create mode 100644 plugins/node/instrumentation-dataloader/src/instrumentation.ts create mode 100644 plugins/node/instrumentation-dataloader/src/types.ts create mode 100644 plugins/node/instrumentation-dataloader/test/dataloader.test.ts create mode 100644 plugins/node/instrumentation-dataloader/tsconfig.json diff --git a/.github/component_owners.yml b/.github/component_owners.yml index ecbe8c6ec8d..3d091e32f4a 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -18,6 +18,8 @@ components: - willarmiros plugins/node/instrumentation-amqplib: - blumamir + plugins/node/instrumentation-dataloader: + - henrinormak plugins/node/instrumentation-fs: - rauno56 plugins/node/instrumentation-tedious: diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md index f9051c17489..21b7c9c8d3b 100644 --- a/metapackages/auto-instrumentations-node/README.md +++ b/metapackages/auto-instrumentations-node/README.md @@ -60,6 +60,7 @@ registerInstrumentations({ - [@opentelemetry/instrumentation-bunyan](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan) - [@opentelemetry/instrumentation-cassandra-driver](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-cassandra) - [@opentelemetry/instrumentation-connect](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-connect) +- [@opentelemetry/instrumentation-dataloader](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-dataloader) - [@opentelemetry/instrumentation-dns](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns) - [@opentelemetry/instrumentation-http](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http) - [@opentelemetry/instrumentation-grpc](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-grpc) diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json index b56184ed753..4720e596978 100644 --- a/metapackages/auto-instrumentations-node/package.json +++ b/metapackages/auto-instrumentations-node/package.json @@ -53,6 +53,7 @@ "@opentelemetry/instrumentation-bunyan": "^0.30.0", "@opentelemetry/instrumentation-cassandra-driver": "^0.30.0", "@opentelemetry/instrumentation-connect": "^0.30.0", + "@opentelemetry/instrumentation-dataloader": "^0.1.0", "@opentelemetry/instrumentation-dns": "^0.30.0", "@opentelemetry/instrumentation-express": "^0.31.1", "@opentelemetry/instrumentation-fastify": "^0.29.0", diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index f85f42eee8d..826dd302214 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -22,6 +22,7 @@ import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk'; import { BunyanInstrumentation } from '@opentelemetry/instrumentation-bunyan'; import { CassandraDriverInstrumentation } from '@opentelemetry/instrumentation-cassandra-driver'; import { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect'; +import { DataloaderInstrumentation } from '@opentelemetry/instrumentation-dataloader'; import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns'; import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express'; import { FastifyInstrumentation } from '@opentelemetry/instrumentation-fastify'; @@ -56,6 +57,7 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-cassandra-driver': CassandraDriverInstrumentation, '@opentelemetry/instrumentation-connect': ConnectInstrumentation, + '@opentelemetry/instrumentation-dataloader': DataloaderInstrumentation, '@opentelemetry/instrumentation-dns': DnsInstrumentation, '@opentelemetry/instrumentation-express': ExpressInstrumentation, '@opentelemetry/instrumentation-fastify': FastifyInstrumentation, diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts index 24d8d561abf..aaef8784eeb 100644 --- a/metapackages/auto-instrumentations-node/test/utils.test.ts +++ b/metapackages/auto-instrumentations-node/test/utils.test.ts @@ -31,6 +31,7 @@ describe('utils', () => { '@opentelemetry/instrumentation-bunyan', '@opentelemetry/instrumentation-cassandra-driver', '@opentelemetry/instrumentation-connect', + '@opentelemetry/instrumentation-dataloader', '@opentelemetry/instrumentation-dns', '@opentelemetry/instrumentation-express', '@opentelemetry/instrumentation-fastify', @@ -57,7 +58,7 @@ describe('utils', () => { '@opentelemetry/instrumentation-restify', '@opentelemetry/instrumentation-winston', ]; - assert.strictEqual(instrumentations.length, 31); + assert.strictEqual(instrumentations.length, 32); for (let i = 0, j = instrumentations.length; i < j; i++) { assert.strictEqual( instrumentations[i].instrumentationName, diff --git a/plugins/node/instrumentation-dataloader/.eslintignore b/plugins/node/instrumentation-dataloader/.eslintignore new file mode 100644 index 00000000000..378eac25d31 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/instrumentation-dataloader/.eslintrc.js b/plugins/node/instrumentation-dataloader/.eslintrc.js new file mode 100644 index 00000000000..6aeb0710ef2 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js'), +} diff --git a/plugins/node/instrumentation-dataloader/.npmignore b/plugins/node/instrumentation-dataloader/.npmignore new file mode 100644 index 00000000000..9505ba9450f --- /dev/null +++ b/plugins/node/instrumentation-dataloader/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/instrumentation-dataloader/.tav.yml b/plugins/node/instrumentation-dataloader/.tav.yml new file mode 100644 index 00000000000..f0baa3a47aa --- /dev/null +++ b/plugins/node/instrumentation-dataloader/.tav.yml @@ -0,0 +1,4 @@ +dataloader: + # Testing ^2.0.0 covers about 90% of the downloaded versions + versions: "^2.0.0" + commands: npm run test diff --git a/plugins/node/instrumentation-dataloader/CHANGELOG.md b/plugins/node/instrumentation-dataloader/CHANGELOG.md new file mode 100644 index 00000000000..825c32f0d03 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/CHANGELOG.md @@ -0,0 +1 @@ +# Changelog diff --git a/plugins/node/instrumentation-dataloader/LICENSE b/plugins/node/instrumentation-dataloader/LICENSE new file mode 100644 index 00000000000..e50e8c80f96 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/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 [2022] 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 + + 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/instrumentation-dataloader/README.md b/plugins/node/instrumentation-dataloader/README.md new file mode 100644 index 00000000000..9f3a1f08328 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/README.md @@ -0,0 +1,70 @@ +# OpenTelemetry instrumentation for dataloader + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for the injection of trace context to [`dataloader`](https://www.npmjs.com/package/dataloader), which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. + +If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-dataloader +``` + +### Supported Versions + +- `^2.0.0` + +## Usage + +```js +const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node"); +const { + DataloaderInstrumentation, +} = require("@opentelemetry/instrumentation-dataloader"); +const { registerInstrumentations } = require("@opentelemetry/instrumentation"); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new DataloaderInstrumentation(), + // other instrumentations + ], +}); +``` + +### Dataloader Instrumentation Options + +Dataloader instrumentation has some configuration options + +| Options | Type | Description | +| ------------------- | --------- | --------------------------------------------------------------------------------------- | +| `requireParentSpan` | `boolean` | Require a parent span in order to create dataloader spans, default when unset is false. | + +### Spans created + +Each call to `.load` or `.loadMany` will create a child span for the current active span. + +The batch load function of the dataloader also creates a span, which links to spans created as part of `.load` and `.loadMany`, it is a child span of whatever the active span is during which the dataloader is created. + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-dataloader +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-dataloader.svg diff --git a/plugins/node/instrumentation-dataloader/package.json b/plugins/node/instrumentation-dataloader/package.json new file mode 100644 index 00000000000..9767f60cf80 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/package.json @@ -0,0 +1,68 @@ +{ + "name": "@opentelemetry/instrumentation-dataloader", + "version": "0.1.0", + "description": "OpenTelemetry instrumentation for dataloader", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "compile": "tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/instrumentation-dataloader --include-dependencies", + "prewatch": "npm run precompile", + "prepare": "npm run compile", + "tdd": "npm run test -- --watch-extensions ts --watch", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "test-all-versions": "tav", + "version:update": "node ../../../scripts/version-update.js" + }, + "keywords": [ + "dataloader", + "instrumentation", + "nodejs", + "opentelemetry", + "profiling", + "tracing" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@opentelemetry/context-async-hooks": "^1.6.0", + "@opentelemetry/sdk-trace-base": "^1.6.0", + "@opentelemetry/sdk-trace-node": "^1.6.0", + "@types/mocha": "7.0.2", + "@types/node": "16.11.21", + "dataloader": "2.0.0", + "gts": "3.1.0", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "test-all-versions": "5.0.1", + "ts-mocha": "10.0.0", + "typescript": "4.3.5" + }, + "dependencies": { + "@opentelemetry/instrumentation": "^0.32.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-dataloader#readme" +} diff --git a/plugins/node/instrumentation-dataloader/src/index.ts b/plugins/node/instrumentation-dataloader/src/index.ts new file mode 100644 index 00000000000..6725a115666 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/src/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { DataloaderInstrumentationConfig } from './types'; +export { DataloaderInstrumentation } from './instrumentation'; diff --git a/plugins/node/instrumentation-dataloader/src/instrumentation.ts b/plugins/node/instrumentation-dataloader/src/instrumentation.ts new file mode 100644 index 00000000000..dd9d1e53df5 --- /dev/null +++ b/plugins/node/instrumentation-dataloader/src/instrumentation.ts @@ -0,0 +1,248 @@ +/* + * 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 { + InstrumentationBase, + InstrumentationNodeModuleDefinition, + isWrapped, +} from '@opentelemetry/instrumentation'; +import { + diag, + trace, + context, + Link, + SpanStatusCode, + SpanKind, +} from '@opentelemetry/api'; +import { DataloaderInstrumentationConfig } from './types'; +import { VERSION } from './version'; +import type * as Dataloader from 'dataloader'; + +const MODULE_NAME = 'dataloader'; + +type DataloaderInternal = typeof Dataloader.prototype & { + _batchLoadFn: Dataloader.BatchLoadFn; + _batch: { spanLinks?: Link[] } | null; +}; + +type LoadFn = typeof Dataloader.prototype['load']; +type LoadManyFn = typeof Dataloader.prototype['loadMany']; + +export class DataloaderInstrumentation extends InstrumentationBase { + constructor(config: DataloaderInstrumentationConfig = {}) { + super('@opentelemetry/instrumentation-dataloader', VERSION, config); + } + + protected init() { + return [ + new InstrumentationNodeModuleDefinition( + MODULE_NAME, + ['^2.0.0'], + (dataloader, moduleVersion) => { + diag.debug(`Applying patch for ${MODULE_NAME}@${moduleVersion}`); + + this._patchLoad(dataloader.prototype); + this._patchLoadMany(dataloader.prototype); + + return this._getPatchedConstructor(dataloader); + }, + (dataloader, moduleVersion) => { + diag.debug(`Removing patch for ${MODULE_NAME}@${moduleVersion}`); + + if (isWrapped(dataloader.prototype.load)) { + this._unwrap(dataloader.prototype, 'load'); + } + + if (isWrapped(dataloader.prototype.loadMany)) { + this._unwrap(dataloader.prototype, 'loadMany'); + } + } + ), + ]; + } + + override getConfig(): DataloaderInstrumentationConfig { + return this._config; + } + + override setConfig(config: DataloaderInstrumentationConfig) { + this._config = config; + } + + private shouldCreateSpans(): boolean { + const config = this.getConfig(); + const hasParentSpan = trace.getSpan(context.active()) !== undefined; + return hasParentSpan || !config.requireParentSpan; + } + + private _getPatchedConstructor( + constructor: typeof Dataloader + ): typeof Dataloader { + const prototype = constructor.prototype; + const self = this; + + function PatchedDataloader( + ...args: ConstructorParameters + ) { + const inst = new constructor(...args) as DataloaderInternal; + + if (!self.isEnabled()) { + return inst; + } + + if (isWrapped(inst._batchLoadFn)) { + self._unwrap(inst, '_batchLoadFn'); + } + + self._wrap(inst, '_batchLoadFn', original => { + return function patchedBatchLoadFn( + this: DataloaderInternal, + ...args: Parameters> + ) { + if (!self.isEnabled() || !self.shouldCreateSpans()) { + return original.call(this, ...args); + } + + const parent = context.active(); + const span = self.tracer.startSpan( + `${MODULE_NAME}.batch`, + { + links: this._batch?.spanLinks as Link[] | undefined, + }, + parent + ); + + return context.with(trace.setSpan(parent, span), () => { + return (original.apply(this, args) as Promise) + .then(value => { + span.end(); + return value; + }) + .catch(err => { + span.recordException(err); + span.setStatus({ + code: SpanStatusCode.ERROR, + message: err.message, + }); + span.end(); + throw err; + }); + }); + }; + }); + + return inst; + } + + PatchedDataloader.prototype = prototype; + return PatchedDataloader as unknown as typeof Dataloader; + } + + private _patchLoad(proto: typeof Dataloader.prototype) { + if (isWrapped(proto.load)) { + this._unwrap(proto, 'load'); + } + + this._wrap(proto, 'load', this._getPatchedLoad.bind(this)); + } + + private _getPatchedLoad(original: LoadFn): LoadFn { + const instrumentation = this; + + return function patchedLoad( + this: typeof Dataloader.prototype, + ...args: Parameters + ) { + if (!instrumentation.shouldCreateSpans()) { + return original.call(this, ...args); + } + + const parent = context.active(); + const span = instrumentation.tracer.startSpan( + `${MODULE_NAME}.load`, + { kind: SpanKind.CLIENT }, + parent + ); + + return context.with(trace.setSpan(parent, span), () => { + const result = original + .call(this, ...args) + .then(value => { + span.end(); + return value; + }) + .catch(err => { + span.recordException(err); + span.setStatus({ + code: SpanStatusCode.ERROR, + message: err.message, + }); + span.end(); + throw err; + }); + + const loader = this as DataloaderInternal; + + if (loader._batch) { + if (!loader._batch.spanLinks) { + loader._batch.spanLinks = []; + } + + loader._batch.spanLinks.push({ context: span.spanContext() } as Link); + } + + return result; + }); + }; + } + + private _patchLoadMany(proto: typeof Dataloader.prototype) { + if (isWrapped(proto.loadMany)) { + this._unwrap(proto, 'loadMany'); + } + + this._wrap(proto, 'loadMany', this._getPatchedLoadMany.bind(this)); + } + + private _getPatchedLoadMany(original: LoadManyFn): LoadManyFn { + const instrumentation = this; + + return function patchedLoadMany( + this: typeof Dataloader.prototype, + ...args: Parameters + ) { + if (!instrumentation.shouldCreateSpans()) { + return original.call(this, ...args); + } + + const parent = context.active(); + const span = instrumentation.tracer.startSpan( + `${MODULE_NAME}.loadMany`, + { kind: SpanKind.CLIENT }, + parent + ); + + return context.with(trace.setSpan(parent, span), () => { + // .loadMany never rejects, as errors from internal .load + // calls are caught by dataloader lib + return original.call(this, ...args).then(value => { + span.end(); + return value; + }); + }); + }; + } +} diff --git a/plugins/node/instrumentation-dataloader/src/types.ts b/plugins/node/instrumentation-dataloader/src/types.ts new file mode 100644 index 00000000000..4ff7a1ac29a --- /dev/null +++ b/plugins/node/instrumentation-dataloader/src/types.ts @@ -0,0 +1,26 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { InstrumentationConfig } from '@opentelemetry/instrumentation'; + +export interface DataloaderInstrumentationConfig extends InstrumentationConfig { + /** + * Whether the instrumentation requires a parent span, if set to true + * and there is no parent span, no additional spans are created + * (default: true) + */ + requireParentSpan?: boolean; +} diff --git a/plugins/node/instrumentation-dataloader/test/dataloader.test.ts b/plugins/node/instrumentation-dataloader/test/dataloader.test.ts new file mode 100644 index 00000000000..b7ca578a91f --- /dev/null +++ b/plugins/node/instrumentation-dataloader/test/dataloader.test.ts @@ -0,0 +1,287 @@ +/* + * 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 { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/sdk-trace-base'; +import { context, SpanKind, SpanStatusCode, trace } from '@opentelemetry/api'; +import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; + +import { DataloaderInstrumentation } from '../src'; +const instrumentation = new DataloaderInstrumentation(); + +// For testing that double shimming/wrapping does not occur +const extraInstrumentation = new DataloaderInstrumentation(); +extraInstrumentation.disable(); + +import * as assert from 'assert'; +import * as Dataloader from 'dataloader'; + +describe('DataloaderInstrumentation', () => { + let dataloader: Dataloader; + let contextManager: AsyncHooksContextManager; + + const memoryExporter = new InMemorySpanExporter(); + const provider = new NodeTracerProvider(); + const tracer = provider.getTracer('default'); + + instrumentation.setTracerProvider(provider); + extraInstrumentation.setTracerProvider(provider); + provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter)); + + beforeEach(async () => { + instrumentation.enable(); + contextManager = new AsyncHooksContextManager(); + context.setGlobalContextManager(contextManager.enable()); + dataloader = new Dataloader(async keys => keys.map((_, idx) => idx), { + cache: false, + }); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); + + afterEach(() => { + memoryExporter.reset(); + context.disable(); + instrumentation.setConfig({}); + instrumentation.disable(); + extraInstrumentation.disable(); + }); + + describe('load', () => { + it('creates a span', async () => { + assert.strictEqual(await dataloader.load('test'), 0); + + // We should have exactly two spans (one for .load and one for the following batch) + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + const [batchSpan, loadSpan] = memoryExporter.getFinishedSpans(); + + assert.strictEqual(loadSpan.name, 'dataloader.load'); + assert.strictEqual(loadSpan.kind, SpanKind.CLIENT); + + // Batch span should also be linked to load span + assert.strictEqual(batchSpan.name, 'dataloader.batch'); + assert.strictEqual(batchSpan.kind, SpanKind.INTERNAL); + assert.deepStrictEqual(batchSpan.links, [ + { context: loadSpan.spanContext(), attributes: {} }, + ]); + }); + + it('attaches span to parent', async () => { + const rootSpan: any = tracer.startSpan('root'); + + await context.with( + trace.setSpan(context.active(), rootSpan), + async () => { + assert.strictEqual(await dataloader.load('test'), 0); + + const [_, loadSpan] = memoryExporter.getFinishedSpans(); + assert.strictEqual( + loadSpan.parentSpanId, + rootSpan.spanContext().spanId + ); + } + ); + }); + + it('attaches span to parent with required parent', async () => { + instrumentation.setConfig({ requireParentSpan: true }); + const rootSpan: any = tracer.startSpan('root'); + + await context.with( + trace.setSpan(context.active(), rootSpan), + async () => { + assert.strictEqual(await dataloader.load('test'), 0); + + const [_, loadSpan] = memoryExporter.getFinishedSpans(); + assert.strictEqual( + loadSpan.parentSpanId, + rootSpan.spanContext().spanId + ); + } + ); + }); + + it('correctly catches exceptions', async () => { + const failingDataloader = new Dataloader(async keys => { + throw new Error('Error message'); + }); + + try { + await failingDataloader.load('test'); + assert.fail('.load should throw'); + } catch (e) {} + + // All spans should be finished, both load as well as the batch ones should have errored + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + const [batchSpan, loadSpan] = memoryExporter.getFinishedSpans(); + + assert.deepStrictEqual(loadSpan.status, { + code: SpanStatusCode.ERROR, + message: 'Error message', + }); + + assert.deepStrictEqual(batchSpan.status, { + code: SpanStatusCode.ERROR, + message: 'Error message', + }); + }); + }); + + describe('loadMany', () => { + it('creates an additional span', async () => { + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + + // We should have exactly three spans (one for .loadMany, one for the underlying .load + // and one for the following batch) + assert.strictEqual(memoryExporter.getFinishedSpans().length, 3); + const [batchSpan, loadSpan, loadManySpan] = + memoryExporter.getFinishedSpans(); + + assert.strictEqual(batchSpan.name, 'dataloader.batch'); + assert.strictEqual(batchSpan.kind, SpanKind.INTERNAL); + assert.deepStrictEqual(batchSpan.links, [ + { context: loadSpan.spanContext(), attributes: {} }, + ]); + + assert.strictEqual(loadManySpan.name, 'dataloader.loadMany'); + assert.strictEqual(loadManySpan.kind, SpanKind.CLIENT); + + assert.strictEqual(loadSpan.name, 'dataloader.load'); + assert.strictEqual(loadSpan.kind, SpanKind.CLIENT); + assert.strictEqual( + loadSpan.parentSpanId, + loadManySpan.spanContext().spanId + ); + }); + + it('attaches span to parent', async () => { + const rootSpan: any = tracer.startSpan('root'); + + await context.with( + trace.setSpan(context.active(), rootSpan), + async () => { + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + + const [, , loadManySpan] = memoryExporter.getFinishedSpans(); + assert.strictEqual( + loadManySpan.parentSpanId, + rootSpan.spanContext().spanId + ); + } + ); + }); + + it('attaches span to parent with required parent', async () => { + instrumentation.setConfig({ requireParentSpan: true }); + const rootSpan: any = tracer.startSpan('root'); + + await context.with( + trace.setSpan(context.active(), rootSpan), + async () => { + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + + const [, , loadManySpan] = memoryExporter.getFinishedSpans(); + assert.strictEqual( + loadManySpan.parentSpanId, + rootSpan.spanContext().spanId + ); + } + ); + }); + + it('never errors, even if underlying load fails', async () => { + const failingDataloader = new Dataloader(async keys => { + throw new Error('Error message'); + }); + + try { + await failingDataloader.loadMany(['test']); + } catch (e) { + assert.fail('.loadMany should never throw'); + } + + // All spans should be finished, both load as well as the batch ones should have errored + // but loadMany one should not have errored + assert.strictEqual(memoryExporter.getFinishedSpans().length, 3); + const [batchSpan, loadSpan, loadManySpan] = + memoryExporter.getFinishedSpans(); + + assert.deepStrictEqual(loadSpan.status, { + code: SpanStatusCode.ERROR, + message: 'Error message', + }); + + assert.deepStrictEqual(batchSpan.status, { + code: SpanStatusCode.ERROR, + message: 'Error message', + }); + + assert.deepStrictEqual(loadManySpan.status, { + code: SpanStatusCode.UNSET, + }); + }); + }); + + it('should not create anything if disabled', async () => { + instrumentation.disable(); + + assert.strictEqual(await dataloader.load('test'), 0); + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + + // Same goes for any new dataloaders that are created while the instrumentation is disabled + const alternativeDataloader = new Dataloader( + async keys => keys.map(() => 1), + { cache: false } + ); + assert.strictEqual(await alternativeDataloader.load('test'), 1); + assert.deepStrictEqual(await alternativeDataloader.loadMany(['test']), [1]); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); + + it('should not create anything if parent span is required, but missing', async () => { + instrumentation.setConfig({ requireParentSpan: true }); + + assert.strictEqual(await dataloader.load('test'), 0); + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + }); + + it('should avoid double shimming of functions', async () => { + extraInstrumentation.enable(); + + // Dataloader created prior to the extra instrumentation + assert.strictEqual(await dataloader.load('test'), 0); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + + assert.deepStrictEqual(await dataloader.loadMany(['test']), [0]); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 5); + memoryExporter.reset(); + + // Same goes for any new dataloaders that are created after the extra instrumentation is added + const alternativeDataloader = new Dataloader( + async keys => keys.map(() => 1), + { cache: false } + ); + assert.strictEqual(await alternativeDataloader.load('test'), 1); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 2); + + assert.deepStrictEqual(await alternativeDataloader.loadMany(['test']), [1]); + assert.strictEqual(memoryExporter.getFinishedSpans().length, 5); + }); +}); diff --git a/plugins/node/instrumentation-dataloader/tsconfig.json b/plugins/node/instrumentation-dataloader/tsconfig.json new file mode 100644 index 00000000000..28be80d266c --- /dev/null +++ b/plugins/node/instrumentation-dataloader/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/release-please-config.json b/release-please-config.json index 9671aba3888..87271a6e39e 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -21,6 +21,7 @@ "plugins/node/instrumentation-lru-memoizer": {}, "plugins/node/instrumentation-mongoose": {}, "plugins/node/instrumentation-amqplib": {}, + "plugins/node/instrumentation-dataloader": {}, "plugins/node/instrumentation-fs": {}, "plugins/node/instrumentation-tedious": {}, "plugins/node/opentelemetry-instrumentation-aws-lambda": {},