refactor: add logger to ather classes

Author: eduardoemery

package.json

@@ -7,7 +7,7 @@
   "repository": "census-instrumentation/opencensus-node",
   "scripts": {
     "postinstall": "npm run bootstrap;npm run build;",
-    "build" : "node_modules/.bin/lerna run build",
+    "build": "node_modules/.bin/lerna run build",
     "bootstrap": "node_modules/.bin/lerna bootstrap",
     "bump": "node_modules/.bin/lerna publish"
   },

packages/opencensus-core/package-lock.json

@@ -24,7 +24,7 @@ const logDriver = require('log-driver');
  */
 class ConsoleLogger implements Logger {
   // tslint:disable:no-any
-  private logger: any;
+  private logger: any; 
   static LEVELS = ['error', 'warn', 'info', 'debug', 'silly'];
 
   /**
@@ -39,8 +39,10 @@ class ConsoleLogger implements Logger {
       opt = options || {};
     }
 
-    this.logger =
-        logDriver({levels: ConsoleLogger.LEVELS, level: opt.level || 'error'});
+    this.logger = logDriver({
+      levels:  ConsoleLogger.LEVELS,
+      level: opt.level || 'silly'
+    });
   }
 
   /**

packages/opencensus-core/src/common/console-logger.ts

@@ -19,10 +19,12 @@ import * as uuidv4 from 'uuid/v4';
 import {debug} from '../internal/util';
 import {RootSpan} from '../trace/model/types';
 import {OnEndSpanEventListener} from '../trace/model/types';
-
+import {Logger} from '../common/types';
 import {Exporter} from './types';
 import {Config, BufferConfig} from '../trace/config/types';
 
+import * as logger from '../common/consolelogger';
+
 
 /** Controls the sending of traces to exporters. */
 export class Buffer {
@@ -38,6 +40,8 @@ export class Buffer {
   private resetTimeout = false;
   /** Indicates when the buffer timeout is running */
   private bufferTimeoutInProgress = false;
+  /** An object to log information to */
+  logger: Logger;
 
   /**
    * Constructs a new Buffer instance.
@@ -46,6 +50,7 @@ export class Buffer {
    */
   constructor(exporter: Exporter, config: BufferConfig) {
     this.exporter = exporter;
+    this.logger = config.logger || logger();
     this.bufferSize = config.bufferSize;
     this.bufferTimeout = config.bufferTimeout;
     return this;
@@ -66,7 +71,7 @@ export class Buffer {
    */
   addToBuffer(trace: RootSpan) {
     this.queue.push(trace);
-    debug('BUFFER: added new trace');
+    this.logger.debug('BUFFER: added new trace');
 
     if (this.queue.length > this.bufferSize) {
       this.flush();
@@ -83,13 +88,13 @@ export class Buffer {
 
   /** Reset the buffer timeout */
   private resetBufferTimeout() {
-    debug('BUFFER: reset timeout');
+    this.logger.debug('BUFFER: reset timeout');
     this.resetTimeout = true;
   }
 
   /** Start the buffer timeout, when finished calls flush method */
   private setBufferTimeout() {
-    debug('BUFFER: set timerout');
+    this.logger.debug('BUFFER: set timerout');
     this.bufferTimeoutInProgress = true;
 
     setTimeout(() => {

packages/opencensus-core/src/exporters/buffer.ts

@@ -17,10 +17,12 @@
 import {Exporter, ExporterConfig} from '../exporters/types';
 import {RootSpan} from '../trace/model/types';
 import {Buffer} from './buffer';
+import {Logger} from '../common/types';
 
 
 /** Do not send span data */
 export class NoopExporter implements Exporter {
+  logger: Logger
   onEndSpan(root: RootSpan) {}
   publish(rootSpans: RootSpan[]) {}
 }
@@ -29,6 +31,7 @@ export class NoopExporter implements Exporter {
 export class ConsoleLogExporter implements Exporter {
   /** Buffer object to store the spans. */
   private buffer: Buffer;
+  logger: Logger;
 
   /**
    * Constructs a new ConsoleLogExporter instance.
@@ -37,6 +40,7 @@ export class ConsoleLogExporter implements Exporter {
    */
   constructor(config: ExporterConfig) {
     this.buffer = new Buffer(this, config);
+    this.logger = config.logger;
   }
 
   /**

packages/opencensus-core/src/exporters/console-exporter.ts

@@ -17,9 +17,12 @@
 
 import {OnEndSpanEventListener, RootSpan} from '../trace/model/types';
 import {BufferConfig} from '../trace/config/types';
+import {Logger} from '../common/types'
 
 /** Defines an exporter interface. */
 export interface Exporter extends OnEndSpanEventListener {
+  /** An object to log information to */
+  logger: Logger
 
   /**
    * Sends a list of root spans to the service.

packages/opencensus-core/src/exporters/types.ts

@@ -21,6 +21,7 @@ export * from './trace/model/types';
 export * from './trace/config/types';
 export * from './trace/instrumentation/types';
 export * from './exporters/types';
+export * from './common/types';
 
 // domain models impls
 export * from './trace/model/rootspan';
@@ -38,4 +39,4 @@ export * from './exporters/buffer';
 export * from './exporters/consolelog-exporter';
 
 // util
-export * from './internal/util';
+export * from './internal/util';

packages/opencensus-core/src/index.ts

@@ -1,5 +1,6 @@
 import {Exporter} from '../../exporters/types';
 import {PluginNames} from '../instrumentation/types';
+import {Logger} from '../../common/types';
 
 /** This interface represent the probability of a tracer. */
 export interface Sampler {
@@ -37,6 +38,7 @@ export interface Sampler {
 export interface BufferConfig {
   bufferSize?: number;
   bufferTimeout?: number;
+  logger?: Logger;
 }
 
 /** Defines tracer configuration parameters */
@@ -45,6 +47,8 @@ export interface TracerConfig {
   samplingRate?: number;
   /** Determines the ignored (or blacklisted) URLs */
   ignoreUrls?: Array<string|RegExp>;
+  /** A logger object to show infos */
+  logger?: Logger;
 }
 
 /** Available configuration options. */
@@ -53,6 +57,7 @@ export interface TracingConfig {
   maximumLabelValueSize?: number;
   plugins?: PluginNames;
   exporter?: Exporter;
+  logger?: Logger;
 }
 
 export type Config = TracingConfig&TracerConfig&BufferConfig;

packages/opencensus-core/src/trace/config/types.ts

@@ -24,6 +24,8 @@ import {SpanBaseModel} from './spanbasemodel';
 import {TracerImpl} from './tracer';
 import {OnEndSpanEventListener, RootSpan, Span, TraceContext, TraceOptions, Tracer} from './types';
 
+import * as logger from '../../common/consolelogger';
+
 /** Defines a root span */
 export class RootSpanImpl extends SpanBaseModel implements RootSpan {
   /** A tracer object */
@@ -50,6 +52,7 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
       this.parentSpanId = context.traceContext.spanId || '';
     }
     this.spansLocal = [];
+    this.logger = tracer.logger || logger();
   }
 
   /** Gets span list from rootspan instance. */
@@ -65,7 +68,7 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
   /** Starts a rootspan instance. */
   start() {
     super.start();
-    debug(
+    this.logger.debug(
         'starting %s  %o', this.className,
         {traceId: this.traceId, id: this.id, parentSpanId: this.parentSpanId});
   }
@@ -89,7 +92,7 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
    * @param span Span ended.
    */
   onEndSpan(span: Span) {
-    debug('ending span  %o', {
+    this.logger.debug('ending span  %o', {
       id: span.id,
       traceId: span.traceId,
       name: span.name,
@@ -107,13 +110,13 @@ export class RootSpanImpl extends SpanBaseModel implements RootSpan {
    */
   startSpan(name: string, type: string, parentSpanId?: string) {
     if (this.ended) {
-      debug(
+      this.logger.debug(
           'calling %s.startSpan() on ended %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
       return;
     }
     if (!this.started) {
-      debug(
+      this.logger.debug(
           'calling %s.startSpan() on un-started %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
       return;

packages/opencensus-core/src/trace/model/root-span.ts

@@ -19,6 +19,7 @@ import {debug, randomSpanId} from '../../internal/util';
 import {Sampler} from '../config/types';
 
 import {Annotation, Attributes, Link, MessageEvent, Span, TraceContext} from './types';
+import {Logger} from '../../common/types';
 
 /** Defines a base model for spans. */
 export abstract class SpanBaseModel implements Span {
@@ -33,6 +34,8 @@ export abstract class SpanBaseModel implements Span {
   private truncated = false;
   /** The Span ID of this span */
   readonly id: string;
+  /** An object to log information to */
+  logger: Logger;
   /** A set of attributes, each in the format [KEY]:[VALUE] */
   attributes: Attributes = {};
   /** A text annotation with a set of attributes. */
@@ -78,7 +81,7 @@ export abstract class SpanBaseModel implements Span {
    */
   get startTime(): Date {
     if (!this.clock) {
-      debug('calling startTime() on null clock');
+      this.logger.debug('calling startTime() on null clock');
       return null;
     }
 
@@ -91,7 +94,7 @@ export abstract class SpanBaseModel implements Span {
    */
   get endTime(): Date {
     if (!this.clock) {
-      debug('calling endTime() on null clock');
+      this.logger.debug('calling endTime() on null clock');
       return null;
     }
 
@@ -104,7 +107,7 @@ export abstract class SpanBaseModel implements Span {
    */
   get duration(): number {
     if (!this.clock) {
-      debug('calling duration() on null clock');
+      this.logger.debug('calling duration() on null clock');
       return null;
     }
 
@@ -176,7 +179,7 @@ export abstract class SpanBaseModel implements Span {
   /** Starts the span. */
   start() {
     if (this.started) {
-      debug(
+      this.logger.debug(
           'calling %s.start() on already started %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
       return;
@@ -188,13 +191,13 @@ export abstract class SpanBaseModel implements Span {
   /** Ends the span. */
   end(): void {
     if (this.ended) {
-      debug(
+      this.logger.debug(
           'calling %s.end() on already ended %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
       return;
     }
     if (!this.started) {
-      debug(
+      this.logger.debug(
           'calling %s.end() on un-started %s %o', this.className,
           this.className, {id: this.id, name: this.name, type: this.type});
       return;
@@ -210,6 +213,7 @@ export abstract class SpanBaseModel implements Span {
     // TODO: review
     this.truncated = true;
     this.end();
-    debug('truncating %s  %o', this.className, {id: this.id, name: this.name});
+    this.logger.debug(
+      'truncating %s  %o', this.className, {id: this.id, name: this.name});
   }
 }