feat: messageEvent should include timestamp (#81)

BREAKING CHANGE: span.addAnnotation now accepts timestamp as its last argument instead of as its second argument.

Author: tcolgate

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

@@ -136,15 +136,15 @@ export abstract class SpanBase implements types.Span {
   /**
    * Adds an annotation to the span.
    * @param description Describes the event.
-   * @param timestamp A timestamp that maks the event.
    * @param attributes A set of attributes on the annotation.
+   * @param timestamp A time, in milliseconds. Defaults to Date.now()
    */
   addAnnotation(
-      description: string, timestamp: number, attributes?: types.Attributes) {
+      description: string, attributes?: types.Attributes, timestamp = 0) {
     this.annotations.push({
       'description': description,
-      'timestamp': timestamp,
       'attributes': attributes,
+      'timestamp': timestamp ? timestamp : Date.now(),
     } as types.Annotation);
   }
 
@@ -170,11 +170,13 @@ export abstract class SpanBase implements types.Span {
    * Adds a message event to the span.
    * @param type The type of message event.
    * @param id An identifier for the message event.
+   * @param timestamp A time in milliseconds. Defaults to Date.now()
    */
-  addMessageEvent(type: string, id: string) {
+  addMessageEvent(type: string, id: string, timestamp = 0) {
     this.messageEvents.push({
       'type': type,
       'id': id,
+      'timestamp': timestamp ? timestamp : Date.now(),
     } as types.MessageEvent);
   }
 
@@ -217,4 +219,4 @@ export abstract class SpanBase implements types.Span {
     this.logger.debug(
         'truncating %s  %o', this.className, {id: this.id, name: this.name});
   }
-}
+}

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

@@ -32,14 +32,16 @@ export interface Attributes { [attributeKey: string]: string|number|boolean; }
 export interface Annotation {
   /** A user-supplied message describing the event. */
   description: string;
-  /** A timestamp that maks the event. */
+  /** A timestamp for the event event. */
   timestamp: number;
   /** A set of attributes on the annotation. */
   attributes: Attributes;
 }
 
 /** An event describing a message sent/received between Spans. */
 export interface MessageEvent {
+  /** A timestamp for the event. */
+  timestamp: number;
   /** Indicates whether the message was sent or received. */
   type: string;
   /** An identifier for the MessageEvent's message. */
@@ -166,11 +168,11 @@ export interface Span {
   /**
    * Adds an annotation to the span.
    * @param description Describes the event.
-   * @param timestamp A timestamp that maks the event.
    * @param attributes A set of attributes on the annotation.
+   * @param timestamp A timestamp for this event.
    */
   addAnnotation(
-      description: string, timestamp: number, attributes?: Attributes): void;
+      description: string, attributes?: Attributes, timestamp?: number): void;
 
   /**
    * Adds a link to the span.
@@ -187,8 +189,9 @@ export interface Span {
    * Adds a message event to the span.
    * @param type The type of message event.
    * @param id An identifier for the message event.
+   * @param timestamp A timestamp for this event.
    */
-  addMessageEvent(type: string, id: string): void;
+  addMessageEvent(type: string, id: string, timestamp?: number): void;
 
   /** Starts a span. */
   start(): void;

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

@@ -205,7 +205,7 @@ describe('RootSpan', () => {
       const rootSpan = new RootSpan(tracer);
       rootSpan.start();
 
-      rootSpan.addAnnotation('description test', Date.now(), {} as Attributes);
+      rootSpan.addAnnotation('description test', {} as Attributes, Date.now());
 
       assert.ok(rootSpan.annotations.length > 0);
       assert.ok(instanceOfAnnotation(rootSpan.annotations[0]));

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

@@ -207,7 +207,7 @@ describe('Span', () => {
       const span = new Span(rootSpan);
       span.start();
 
-      span.addAnnotation('description test', Date.now(), {} as Attributes);
+      span.addAnnotation('description test', {} as Attributes, Date.now());
 
       assert.ok(span.annotations.length > 0);
       assert.ok(instanceOfAnnotation(span.annotations[0]));
@@ -260,4 +260,4 @@ describe('Span', () => {
       assert.ok(instanceOfLink(span.messageEvents[0]));
     });
   });
-});
+});