chore(otel-node): disable fastify instrumentation and update docs

packages/opentelemetry-node/docs/supported-technologies.md

@@ -70,6 +70,24 @@ requires:
 | `@opentelemetry/instrumentation-undici` | `undici` version range `>=5.12.0` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-undici#readme) |
 | `@opentelemetry/instrumentation-winston` | `winston` version range `>1 <4` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-winston#readme) |
 
+### Disabled instrumentations
+
+This Distro takes the upstream package `@opentelemetry/auto-instrumentations-node` as a baseline for technology support. This means additions or removals in its instrumentation list will be revised and usually applied here. As for now the list includes a couple of instrumentations that are disabled by default:
+
+- `@opentelemetry/instrumentation-fs`: Disabled in [opentelemetry-js-contrib/pull/2467](https://github.com/open-telemetry/opentelemetry-js-contrib/pull/2467).
+- `@opentelemetry/instrumentation-fastify`: Disabled in [opentelemetry-js-contrib/pull/2652](https://github.com/open-telemetry/opentelemetry-js-contrib/pull/2652).
+
+If you want to enable these instrumentations you should make use of the environment var `OTEL_NODE_ENABLED_INSTRUMENTATIONS` defined
+in [zero-code instrumentation docs](https://opentelemetry.io/docs/zero-code/js/configuration/). Make sure you put all the instrumentations
+you need for your service since only the ones in that list will be enabled.
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io
+export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer P....l"
+export OTEL_NODE_ENABLED_INSTRUMENTATIONS="fs,http,fastify" # only the ones in the list would be enabled
+node --import @elastic/opentelemetry-node my-service.js
+```
+
 ## Native Instrumentations
 
 "Native" instrumentation refers to OpenTelemetry instrumentation that is built into a library. When a library includes native OTel instrumentation, it will provide telemetry data to providers registered by a running OTel SDK. Native instrumentations of note are listed in the table below. To benefit from these instrumentations you only need to (a) use the library and (b) start the EDOT Node.js SDK:

packages/opentelemetry-node/lib/instrumentations.js

@@ -164,6 +164,11 @@ const INSTRUMENTATIONS = {
 };
 /* eslint-enable prettier/prettier */
 
+const EXCLUDED_INSTRUMENTATIONS = new Set([
+    '@opentelemetry/instrumentation-fastify',
+    '@opentelemetry/instrumentation-fs',
+]);
+
 /**
  * Reads a string in the format `value1,value2` and parses
  * it into an array. This is the format specified for comma separated
@@ -288,9 +293,9 @@ function getInstrumentations(opts = {}) {
 
         if (enabledFromEnv) {
             instrConfig = {...instrConfig, enabled: true};
-        } else if (name === '@opentelemetry/instrumentation-fs') {
-            // if `fs` not present in envvar instrumentation is disabled
-            // unless an explicit config says the opposite
+        } else if (EXCLUDED_INSTRUMENTATIONS.has(name)) {
+            // if excluded instrumentations not present in envvar the instrumentation
+            // is disabled unless an explicit config says the opposite
             // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/pull/2467
             instrConfig = {enabled: false, ...instrConfig};
         }

packages/opentelemetry-node/test/instr-fastify.test.js

@@ -29,7 +29,7 @@ const {
 /** @type {import('./testutils').TestFixture[]} */
 const testFixtures = [
     {
-        name: 'use-fastify',
+        name: 'use-fastify (default disabled)',
         args: ['./fixtures/use-fastify.js'],
         cwd: __dirname,
         env: {
@@ -40,6 +40,47 @@ const testFixtures = [
             node: '>=20.0.0',
         },
         // verbose: true,
+        checkTelemetry: (t, col) => {
+            // We expect spans like this
+            // ------ trace 9042af (3 spans) ------
+            //         span 5894e1 "GET" (6.8ms, SPAN_KIND_CLIENT, GET http://localhost:3000/ping -> 200)
+            //     +3ms `- span c793a1 "GET /ping" (2.7ms, SPAN_KIND_SERVER, GET http://localhost:3000/ping -> 200)
+            // ------ trace 8f3ed8 (3 spans) ------
+            //         span 6e0fc9 "GET" (1.6ms, SPAN_KIND_CLIENT, GET http://localhost:3000/hi/Bob -> 200)
+            //     +1ms `- span 40c4a8 "GET /hi/:name" (0.3ms, SPAN_KIND_SERVER, GET http://localhost:3000/hi/Bob -> 200)
+            const spans = filterOutDnsNetSpans(col.sortedSpans);
+
+            t.equal(spans.length, 4);
+            t.ok(
+                spans.every(
+                    (s) =>
+                        s.scope.name === '@opentelemetry/instrumentation-http'
+                )
+            );
+            t.ok(spans.every((s) => s.name === 'GET'));
+            t.equal(
+                spans.filter((s) => s.kind === 'SPAN_KIND_CLIENT').length,
+                2
+            );
+            t.equal(
+                spans.filter((s) => s.kind === 'SPAN_KIND_SERVER').length,
+                2
+            );
+        },
+    },
+    {
+        name: 'use-fastify (enabled via env var)',
+        args: ['./fixtures/use-fastify.js'],
+        cwd: __dirname,
+        env: {
+            NODE_OPTIONS: '--require=@elastic/opentelemetry-node',
+            OTEL_NODE_ENABLED_INSTRUMENTATIONS: 'http,fastify',
+        },
+        versionRanges: {
+            // Ref: https://fastify.dev/docs/latest/Guides/Migration-Guide-V5/#long-term-support-cycle
+            node: '>=20.0.0',
+        },
+        // verbose: true,
         checkTelemetry: (t, col) => {
             // We expect spans like this
             // ------ trace 9042af (3 spans) ------