Feat/plugin injection

packages/opentelemetry-api/src/trace/instrumentation/Plugin.ts

@@ -64,6 +64,12 @@ export interface PluginConfig {
    */
   path?: string;
 
+  /**
+   * Plugin to load
+   * @example import {plugin} from '@opentelemetry/plugin-http' in case of http.
+   */
+  plugin?: Plugin;
+
   /**
    * Request methods that match any string in ignoreMethods will not be traced.
    */

packages/opentelemetry-node/README.md

@@ -82,9 +82,12 @@ In the following example:
 - the default express plugin is disabled
 - the http plugin has a custom config for a `requestHook`
 - the customPlugin is loaded from the user supplied path
+- the customPlugin2 is resolved locally and injected
 - all default plugins are still loaded if installed.
 
 ```js
+import {plugin as httpsPlugin} from '@opentelemetry/plugin-https';
+
 const provider = new NodeTracerProvider({
   plugins: {
     express: {
@@ -98,6 +101,9 @@ const provider = new NodeTracerProvider({
     customPlugin: {
       path: "/path/to/custom/module",
     },
+    customPlugin2: {
+      plugin: httpsPlugin,
+    },
   },
 });
 ```

packages/opentelemetry-node/src/instrumentation/PluginLoader.ts

@@ -52,7 +52,9 @@ export interface Plugins {
 function filterPlugins(plugins: Plugins): Plugins {
   const keys = Object.keys(plugins);
   return keys.reduce((acc: Plugins, key: string) => {
-    if (plugins[key].enabled && plugins[key].path) acc[key] = plugins[key];
+    if (plugins[key].enabled && (plugins[key].path || plugins[key].plugin)) {
+      acc[key] = plugins[key];
+    }
     return acc;
   }, {});
 }
@@ -131,6 +133,7 @@ export class PluginLoader {
         if (this._hookState !== HookState.ENABLED) return exports;
         const config = pluginsToLoad[name];
         const modulePath = config.path!;
+        const modulePlugin = config.plugin;
         let version = null;
 
         if (!baseDir) {
@@ -170,7 +173,7 @@ export class PluginLoader {
 
         // Expecting a plugin from module;
         try {
-          const plugin: Plugin = require(modulePath).plugin;
+          const plugin: Plugin = modulePlugin ?? require(modulePath).plugin;
           if (!utils.isSupportedVersion(version, plugin.supportedVersions)) {
             this.logger.warn(
               `PluginLoader#load: Plugin ${name} only supports module ${plugin.moduleName} with the versions: ${plugin.supportedVersions}`

packages/opentelemetry-node/test/instrumentation/PluginLoader.test.ts

@@ -37,6 +37,14 @@ const simplePlugins: Plugins = {
   },
 };
 
+const simpleModulePlugin = require('@opentelemetry/plugin-simple-module');
+const resolvedPlugins: Plugins = {
+  'simple-module': {
+    enabled: true,
+    plugin: simpleModulePlugin.plugin,
+  },
+};
+
 const httpPlugins: Plugins = {
   http: {
     enabled: true,
@@ -249,6 +257,18 @@ describe('PluginLoader', () => {
       pluginLoader.unload();
     });
 
+    it('should load a resolved plugin and patch the target modules', () => {
+      const pluginLoader = new PluginLoader(provider, logger);
+      assert.strictEqual(pluginLoader['_plugins'].length, 0);
+      pluginLoader.load(resolvedPlugins);
+      // The hook is only called the first time the module is loaded.
+      const simpleModule = require('simple-module');
+      assert.strictEqual(pluginLoader['_plugins'].length, 1);
+      assert.strictEqual(simpleModule.value(), 1);
+      assert.strictEqual(simpleModule.name(), 'patched-simple-module');
+      pluginLoader.unload();
+    });
+
     it('should load a plugin and patch the core module', () => {
       const pluginLoader = new PluginLoader(provider, logger);
       assert.strictEqual(pluginLoader['_plugins'].length, 0);