Diag channels based esbuild plugin for auto instrumentation

Author: drewcorlin1

packages/esbuild-plugin-node/src/common.ts

@@ -18,56 +18,24 @@ import type { ModuleParams } from './types';
 
 export function wrapModule(
   originalSource: string,
-  {
-    path,
-    moduleVersion,
-    oTelInstrumentationPackage,
-    oTelInstrumentationClass,
-    instrumentationName,
-    oTelInstrumentationConstructorArgs = '',
-  }: ModuleParams
+  { path, moduleVersion, instrumentationName }: ModuleParams
 ) {
   return `
 (function() {
   ${originalSource}
 })(...arguments);
 {
-  const { diag } = require('@opentelemetry/api');
-
-  try {
-    let mod = module.exports;
-
-    const { satisfies } = require('semver');
-    const { ${oTelInstrumentationClass} } = require('${oTelInstrumentationPackage}');
-    const instrumentations = new ${oTelInstrumentationClass}(${oTelInstrumentationConstructorArgs}).getModuleDefinitions();
-
-    for (const instrumentation of instrumentations.filter(i => i.name === '${instrumentationName}')) {
-      if (!instrumentation.supportedVersions.some(v => satisfies('${moduleVersion}', v))) {
-        diag.debug('Skipping instrumentation ${instrumentationName}, because module version ${moduleVersion} does not match supported versions ' + instrumentation.supportedVersions.join(','));
-        continue;
-      }
-
-      if (instrumentation.patch) {
-        diag.debug('Applying instrumentation patch ${instrumentationName} via esbuild-plugin-node');
-        mod = instrumentation.patch(mod)
-      }
-
-      if (instrumentation.files?.length) {
-        for (const file of instrumentation.files.filter(f => f.name === '${path}')) {
-          if (!file.supportedVersions.some(v => satisfies('${moduleVersion}', v))) {
-            diag.debug('Skipping instrumentation for ${path}@${moduleVersion} because it does not match supported versions' + file.supportedVersions.join(','));
-            continue;
-          }
-          diag.debug('Applying instrumentation patch to ${path}@${moduleVersion} via esbuild-plugin-node');
-          mod = file.patch(mod, '${moduleVersion}');
-        }
-      }
-    }
-
-    module.exports = mod;
-  } catch (e) {
-    diag.error('Error applying instrumentation ${instrumentationName}', e);
-  }
+    const diagch = require('diagnostics_channel');
+    const ch = diagch.channel('otel:bundle:load');
+
+    const pathMessage = {
+      name: '${instrumentationName}' || undefined,
+      file: '${path}' || undefined,
+      version: '${moduleVersion}',
+      exports: module.exports,
+    };
+    ch.publish(pathMessage);
+    module.exports = pathMessage.exports;
 }
 `;
 }

packages/esbuild-plugin-node/src/plugin.ts

@@ -114,11 +114,6 @@ export function openTelemetryPlugin(
             otelPackageToInstrumentationConfig[pluginData.instrumentationName];
           if (!config) return;
 
-          // console.log('config is', config);
-          const packageConfig =
-            pluginConfig?.instrumentationConfig?.[
-              config.oTelInstrumentationPackage
-            ];
           const extractedModule = pluginData.extractedModule;
 
           return {
@@ -129,10 +124,6 @@ export function openTelemetryPlugin(
               ),
               moduleVersion: pluginData.moduleVersion,
               instrumentationName: pluginData.instrumentationName,
-              oTelInstrumentationClass: config.oTelInstrumentationClass,
-              oTelInstrumentationPackage: config.oTelInstrumentationPackage,
-              oTelInstrumentationConstructorArgs:
-                config.configGenerator(packageConfig),
             }),
             resolveDir: dirname(path),
           };

packages/esbuild-plugin-node/src/types.ts

@@ -35,9 +35,6 @@ export type OnLoadArgs = Omit<EsbuildOnLoadArgs, 'pluginData'> & {
 
 export interface ModuleParams {
   path?: string;
-  oTelInstrumentationPackage: string;
-  oTelInstrumentationClass: string;
-  oTelInstrumentationConstructorArgs?: string;
   instrumentationName?: string;
   moduleVersion: string;
 }
@@ -68,8 +65,6 @@ export type EsbuildInstrumentationConfigMap = {
 };
 
 export interface OpenTelemetryPluginParams {
-  instrumentationConfig?: EsbuildInstrumentationConfigMap;
-
   /** Modules to consider external and ignore from the plugin */
   externalModules?: string[];
 

packages/esbuild-plugin-node/test/plugin.test.ts

@@ -79,7 +79,6 @@ describe('Esbuild can instrument packages via a plugin', function () {
     await exec(`ts-node ${__dirname}/test-app/build.ts`);
 
     const proc = startTestApp();
-
     assert.ifError(proc.error);
     assert.equal(proc.status, 0, `proc.status (${proc.status})`);
     assert.equal(proc.signal, null, `proc.signal (${proc.signal})`);
@@ -96,15 +95,7 @@ describe('Esbuild can instrument packages via a plugin', function () {
     );
   });
 
-  it('fastify and pino', async () => {
-    assert.ok(
-      stdOutLines.find(
-        logLine =>
-          logLine ===
-          'OpenTelemetry automatic instrumentation started successfully'
-      )
-    );
-
+  it('fastify and pino', () => {
     const traceId = getTraceId(
       stdOutLines,
       'request handler - fastify -> @fastify/rate-limit'
@@ -121,13 +112,13 @@ describe('Esbuild can instrument packages via a plugin', function () {
     assert.equal(traceId, trace_id, 'Pino logs include trace ID');
   });
 
-  it('redis', async () => {
+  it('redis', () => {
     const traceId = getTraceId(stdOutLines, 'redis-GET');
 
     assert.ok(traceId, 'console span output in stdout contains a redis span');
   });
 
-  it('mongodb', async () => {
+  it('mongodb', () => {
     const traceId = getTraceId(stdOutLines, 'mongodb.find');
 
     assert.ok(traceId, 'console span output in stdout contains a traceId');

packages/esbuild-plugin-node/test/test-app/register.js

@@ -16,15 +16,36 @@
 
 const opentelemetry = require('@opentelemetry/sdk-node');
 const { DiagConsoleLogger, diag } = require('@opentelemetry/api');
+const {
+  getNodeAutoInstrumentations,
+} = require('@opentelemetry/auto-instrumentations-node');
+const {
+  FastifyInstrumentation,
+} = require('@opentelemetry/instrumentation-fastify');
+const {
+  RedisInstrumentation: RedisInstrumentationV4,
+} = require('@opentelemetry/instrumentation-redis-4');
+const { PinoInstrumentation } = require('@opentelemetry/instrumentation-pino');
+const {
+  MongoDBInstrumentation,
+} = require('@opentelemetry/instrumentation-mongodb');
+const {
+  GraphQLInstrumentation,
+} = require('@opentelemetry/instrumentation-graphql');
 
 diag.setLogger(
   new DiagConsoleLogger(),
   opentelemetry.core.getEnv().OTEL_LOG_LEVEL
 );
 
 const sdk = new opentelemetry.NodeSDK({
-  // Notably instrumentation fastify, pino and graphql are not in here
-  instrumentations: [],
+  instrumentations: [
+    new FastifyInstrumentation(),
+    new RedisInstrumentationV4(),
+    new PinoInstrumentation(),
+    new MongoDBInstrumentation(),
+    new GraphQLInstrumentation(),
+  ],
 });
 
 try {