feat: add dataloader instrumentation (open-telemetry#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 <Rauno56@users.noreply.github.com>

Author: henrinormak

.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:

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)

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",

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,

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,

plugins/node/instrumentation-dataloader/.eslintignore

@@ -0,0 +1 @@
+build

plugins/node/instrumentation-dataloader/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    "env": {
+        "mocha": true,
+        "node": true
+    },
+    ...require('../../../eslint.config.js'),
+}

plugins/node/instrumentation-dataloader/.npmignore

@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test

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

plugins/node/instrumentation-dataloader/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog