update plugin loader (#386)

census-instrumentation · Apr 1, 2019 · 27de0b1 · 27de0b1
1 parent cbd1d99
commit 27de0b1
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 34 deletions.
diff --git a/examples/http/client.js b/examples/http/client.js
@@ -14,15 +14,19 @@
  * limitations under the License.
  */
 
-const path = require('path');
-const http = require('http');
 const tracing = require('@opencensus/nodejs');
-const { plugin } = require('@opencensus/instrumentation-http');
 const { ZipkinTraceExporter } = require('@opencensus/exporter-zipkin');
 const { TraceContextFormat } = require('@opencensus/propagation-tracecontext');
 
+/**
+ * The trace instance needs to be initialized first, if you want to enable
+ * automatic tracing for built-in plugins (HTTP in this case).
+ * https://github.com/census-instrumentation/opencensus-node#plugins
+ */
 const tracer = setupTracerAndExporters();
 
+const http = require('http');
+
 /** A function which makes requests and handles response. */
 function makeRequest () {
   // Root spans typically correspond to incoming requests, while child spans
@@ -38,7 +42,7 @@ function makeRequest () {
       let body = [];
       response.on('data', chunk => body.push(chunk));
       response.on('end', () => {
-        console.log(body);
+        console.log(body.toString());
         rootSpan.end();
       });
     });
@@ -54,19 +58,14 @@ function setupTracerAndExporters () {
   // Creates Zipkin exporter
   const exporter = new ZipkinTraceExporter(zipkinOptions);
 
-  // Starts tracing and set sampling rate
-  const tracer = tracing.registerExporter(exporter).start({
+  // Starts tracing and set sampling rate, exporter and propagation
+  const tracer = tracing.start({
+    exporter,
     samplingRate: 1, // For demo purposes, always sample
-    propagation: new TraceContextFormat()
+    propagation: new TraceContextFormat(),
+    logLevel: 1 // show errors, if any
   }).tracer;
 
-  // Defines basedir and version
-  const basedir = path.dirname(require.resolve('http'));
-  const version = process.versions.node;
-
-  // Enables HTTP plugin: Method that enables the instrumentation patch.
-  plugin.enable(http, tracer, version, /** plugin options */{}, basedir);
-
   return tracer;
 }
 

diff --git a/examples/http/package.json b/examples/http/package.json
@@ -21,7 +21,6 @@
   },
   "dependencies": {
     "@opencensus/exporter-zipkin": "^0.0.9",
-    "@opencensus/instrumentation-http": "^0.0.9",
     "@opencensus/nodejs": "^0.0.9",
     "@opencensus/propagation-tracecontext": "^0.0.9",
     "http": "*"

diff --git a/examples/http/server.js b/examples/http/server.js
@@ -14,15 +14,19 @@
  * limitations under the License.
  */
 
-const path = require('path');
-const http = require('http');
 const tracing = require('@opencensus/nodejs');
-const { plugin } = require('@opencensus/instrumentation-http');
 const { ZipkinTraceExporter } = require('@opencensus/exporter-zipkin');
 const { TraceContextFormat } = require('@opencensus/propagation-tracecontext');
 
+/**
+ * The trace instance needs to be initialized first, if you want to enable
+ * automatic tracing for built-in plugins (HTTP in this case).
+ * https://github.com/census-instrumentation/opencensus-node#plugins
+ */
 const tracer = setupTracerAndExporters();
 
+const http = require('http');
+
 /** Starts a HTTP server that receives requests on sample server port. */
 function startServer (port) {
   // Creates a server
@@ -65,19 +69,14 @@ function setupTracerAndExporters () {
   // Creates Zipkin exporter
   const exporter = new ZipkinTraceExporter(zipkinOptions);
 
-  // Starts tracing and set sampling rate
-  const tracer = tracing.registerExporter(exporter).start({
+  // Starts tracing and set sampling rate, exporter and propagation
+  const tracer = tracing.start({
+    exporter,
     samplingRate: 1, // For demo purposes, always sample
-    propagation: new TraceContextFormat()
+    propagation: new TraceContextFormat(),
+    logLevel: 1 // show errors, if any
   }).tracer;
 
-  // Defines basedir and version
-  const basedir = path.dirname(require.resolve('http'));
-  const version = process.versions.node;
-
-  // Enables HTTP plugin: Method that enables the instrumentation patch.
-  plugin.enable(http, tracer, version, /** plugin options */{}, basedir);
-
   return tracer;
 }
 

diff --git a/packages/opencensus-core/src/trace/config/types.ts b/packages/opencensus-core/src/trace/config/types.ts
@@ -16,6 +16,7 @@
 
 import {Logger} from '../../common/types';
 import {Exporter} from '../../exporters/types';
+import {Stats} from '../../stats/types';
 import {PluginNames} from '../instrumentation/types';
 import {Propagation} from '../propagation/types';
 
@@ -70,6 +71,8 @@ export interface TracingConfig {
   exporter?: Exporter;
   /** An instance of a logger  */
   logger?: Logger;
+  /** An instance of a stats  */
+  stats?: Stats;
 }
 
 /** Global configuration of trace service */

diff --git a/packages/opencensus-nodejs/src/trace/instrumentation/plugin-loader.ts b/packages/opencensus-nodejs/src/trace/instrumentation/plugin-loader.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import {Logger, Plugin, PluginConfig, PluginNames, Tracer} from '@opencensus/core';
+import {Logger, Plugin, PluginConfig, PluginNames, Stats, Tracer} from '@opencensus/core';
 import * as fs from 'fs';
 import * as path from 'path';
 import * as hook from 'require-in-the-middle';
@@ -36,6 +36,8 @@ export class PluginLoader {
   private tracer: Tracer;
   /** logger */
   private logger: Logger;
+  /** The stats */
+  private stats?: Stats;
   /** A list of loaded plugins. */
   plugins: Plugin[] = [];
   /**
@@ -48,9 +50,10 @@ export class PluginLoader {
    * Constructs a new PluginLoader instance.
    * @param tracer The tracer.
    */
-  constructor(logger: Logger, tracer: Tracer) {
+  constructor(logger: Logger, tracer: Tracer, stats?: Stats) {
     this.tracer = tracer;
     this.logger = logger;
+    this.stats = stats;
   }
 
   /**
@@ -64,7 +67,6 @@ export class PluginLoader {
         Constants.DEFAULT_PLUGIN_PACKAGE_NAME_PREFIX}-${moduleName}`;
   }
 
-
   /**
    * Returns a PluginNames object, build from a string array of target modules
    * names, using the defaultPackageName.
@@ -140,7 +142,7 @@ export class PluginLoader {
           const plugin: Plugin = require(moduleName as string).plugin;
           this.plugins.push(plugin);
           return plugin.enable(
-              exports, this.tracer, version, moduleConfig, basedir);
+              exports, this.tracer, version, moduleConfig, basedir, this.stats);
         } catch (e) {
           this.logger.error(
               'could not load plugin %s of module %s. Error: %s', moduleName,
@@ -152,7 +154,6 @@ export class PluginLoader {
     this.hookState = HookState.ENABLED;
   }
 
-
   /** Unloads plugins. */
   unloadPlugins() {
     for (const plugin of this.plugins) {

diff --git a/packages/opencensus-nodejs/src/trace/tracing.ts b/packages/opencensus-nodejs/src/trace/tracing.ts
@@ -74,7 +74,8 @@ export class Tracing implements core.Tracing {
         this.configLocal.logger || logger.logger(this.configLocal.logLevel);
     this.configLocal.logger = this.logger;
     this.logger.debug('config: %o', this.configLocal);
-    this.pluginLoader = new PluginLoader(this.logger, this.tracer);
+    this.pluginLoader =
+        new PluginLoader(this.logger, this.tracer, this.configLocal.stats);
     this.pluginLoader.loadPlugins(this.configLocal.plugins as core.PluginNames);
 
     if (!this.configLocal.exporter) {