Sync @opencensus/web-types to @opencensus/core v0.0.12 (#80)

Author: crdgonzalezca

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

@@ -192,10 +192,13 @@ export class Span implements webTypes.Span {
   /**
    * Adds an attribute to the span.
    * @param key Describes the value added.
-   * @param value What value to set for the attribute.
+   * @param value What value to set for the attribute. If the value is a typeof object
+   *        it has to be JSON.stringify-able, cannot contain circular dependencies.
    */
-  addAttribute(key: string, value: string | number | boolean) {
-    this.attributes[key] = value;
+  addAttribute(key: string, value: string | number | boolean | object) {
+    const serializedValue =
+      typeof value === 'object' ? JSON.stringify(value) : value;
+    this.attributes[key] = serializedValue;
   }
 
   /**

packages/opencensus-web-core/src/trace/model/tracer-base.ts

@@ -52,6 +52,9 @@ export class TracerBase implements webTypes.TracerBase {
    */
   readonly activeTraceParams = {};
 
+  /** A configuration for starting the tracer */
+  private config: webTypes.TracerConfig = {};
+
   /**
    * Starts the tracer. This makes the tracer active and sets `logger` and
    * `propagation` based on the given config. The `samplingRate` property of
@@ -60,6 +63,7 @@ export class TracerBase implements webTypes.TracerBase {
   start(config: webTypes.TracerConfig): this {
     this.logger = config.logger || console;
     this.propagation = config.propagation || NO_HEADERS_PROPAGATION;
+    this.config = config;
     return this;
   }
 
@@ -76,6 +80,13 @@ export class TracerBase implements webTypes.TracerBase {
    */
   startRootSpan<T>(options: webTypes.TraceOptions, fn: (root: Span) => T): T {
     const rootSpan = new RootSpan(this, options);
+    // Add default attributes
+    const defaultAttributes = this.config && this.config.defaultAttributes;
+    if (defaultAttributes) {
+      for (const key of Object.keys(defaultAttributes)) {
+        rootSpan.addAttribute(key, defaultAttributes[key]);
+      }
+    }
     rootSpan.start();
     return fn(rootSpan);
   }
@@ -108,10 +119,18 @@ export class TracerBase implements webTypes.TracerBase {
    * @returns The new Span instance started
    */
   startChildSpan(options?: webTypes.SpanOptions): Span {
-    let span = new Span();
+    let rootSpan = new Span();
     if (options && options.childOf) {
-      span = options.childOf as Span;
+      rootSpan = options.childOf as Span;
+    }
+    const span = rootSpan.startChildSpan(options);
+    // Add default attributes
+    const defaultAttributes = this.config && this.config.defaultAttributes;
+    if (defaultAttributes) {
+      for (const key of Object.keys(defaultAttributes)) {
+        rootSpan.addAttribute(key, defaultAttributes[key]);
+      }
     }
-    return span.startChildSpan(options);
+    return span;
   }
 }

packages/opencensus-web-core/test/test-span.ts

@@ -103,8 +103,13 @@ describe('Span', () => {
 
   it('sets attribute when addAttribute called', () => {
     span.addAttribute('attr1', 23);
-
     expect(span.attributes).toEqual({ attr1: 23 });
+
+    span.addAttribute('object', { foo: 'bar' });
+    expect(span.attributes['object']).toEqual('{"foo":"bar"}');
+
+    span.addAttribute('array', [1, 2, 3]);
+    expect(span.attributes['array']).toEqual('[1,2,3]');
   });
 
   it('adds link when addLink called', () => {

packages/opencensus-web-types/package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "npm run compile",
     "clean": "rimraf build/*",
-    "copytypes": "node scripts/copy-types.js '92edaa9d406ac74e1805a4e80b756acedc413001' && npm run fix",
+    "copytypes": "node scripts/copy-types.js 'v0.0.12' && npm run fix",
     "check": "gts check",
     "compile": "tsc -p .",
     "fix": "gts fix",

packages/opencensus-web-types/src/stats/types.ts

@@ -98,7 +98,7 @@ export interface Stats {
 
   /**
    * Gets a collection of produced Metric`s to be exported.
-   * @returns {Metric[]} List of metrics
+   * @returns The List of metrics.
    */
   getMetrics(): Metric[];
 

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

@@ -18,6 +18,7 @@ import { Logger } from '../../common/types';
 import { Exporter } from '../../exporters/types';
 import { Stats } from '../../stats/types';
 import { PluginNames } from '../instrumentation/types';
+import { Attributes } from '../model/types';
 import { Propagation } from '../propagation/types';
 
 /** Interface configuration for a buffer. */
@@ -32,6 +33,8 @@ export interface BufferConfig {
 
 /** Defines tracer configuration parameters */
 export interface TracerConfig {
+  /** A set of default attributes each in the format [KEY]:[VALUE] */
+  defaultAttributes?: Attributes;
   /** Determines the sampling rate. Ranges from 0.0 to 1.0 */
   samplingRate?: number;
   /** A logger object  */

packages/opencensus-web-types/src/trace/model/types.ts

@@ -407,7 +407,7 @@ export interface Span {
    * @param key Describes the value added.
    * @param value The result of an operation.
    */
-  addAttribute(key: string, value: string | number | boolean): void;
+  addAttribute(key: string, value: string | number | boolean | object): void;
 
   /**
    * Adds an annotation to the span.