Update uncompressedSize and compressedSize for exporters (#347)

census-instrumentation · Feb 18, 2019 · 0605a67 · 0605a67
1 parent 9d592e6
commit 0605a67
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 15 deletions.
diff --git a/packages/opencensus-core/src/trace/model/types.ts b/packages/opencensus-core/src/trace/model/types.ts
@@ -418,8 +418,13 @@ export interface Span {
    * @param type The type of message event.
    * @param id An identifier for the message event.
    * @param timestamp A timestamp for this event.
+   * @param uncompressedSize The number of uncompressed bytes sent or received.
+   * @param compressedSize The number of compressed bytes sent or received. If
+   *     zero or undefined, assumed to be the same size as uncompressed.
    */
-  addMessageEvent(type: MessageEventType, id: string, timestamp?: number): void;
+  addMessageEvent(
+      type: MessageEventType, id: string, timestamp?: number,
+      uncompressedSize?: number, compressedSize?: number): void;
 
   /**
    * Sets a status to the span.

diff --git a/packages/opencensus-exporter-ocagent/src/adapters.ts b/packages/opencensus-exporter-ocagent/src/adapters.ts
@@ -181,7 +181,9 @@ const adaptTimeEvents =
             messageEvent: {
               // tslint:disable-next-line:ban Needed to parse hexadecimal.
               id: parseInt(messageEvent.id, 16),
-              type: adaptMessageEventType(messageEvent.type)
+              type: adaptMessageEventType(messageEvent.type),
+              uncompressedSize: messageEvent.uncompressedSize || 0,
+              compressedSize: messageEvent.compressedSize || 0
             }
           });
         });

diff --git a/packages/opencensus-exporter-ocagent/test/test-ocagent.ts b/packages/opencensus-exporter-ocagent/test/test-ocagent.ts
@@ -360,7 +360,8 @@ describe('OpenCensus Agent Exporter', () => {
       // Message Event
       const timeStamp = 123456789;
       rootSpan.addMessageEvent(MessageEventType.SENT, 'aaaa', timeStamp);
-      rootSpan.addMessageEvent(MessageEventType.SENT, 'ffff', timeStamp);
+      rootSpan.addMessageEvent(
+          MessageEventType.SENT, 'ffff', timeStamp, 100, 12);
       rootSpan.addMessageEvent(MessageEventType.RECEIVED, 'ffff', timeStamp);
       // Use of `null` is to force a `TYPE_UNSPECIFIED` value
       // tslint:disable-next-line:no-any
@@ -476,10 +477,10 @@ describe('OpenCensus Agent Exporter', () => {
                 },
                 {
                   messageEvent: {
-                    compressedSize: '0',
+                    compressedSize: '12',
                     id: '65535',
                     type: 'SENT',
-                    uncompressedSize: '0'
+                    uncompressedSize: '100'
                   },
                   time: {seconds: '123456', nanos: 789000000},
                   value: 'messageEvent'

diff --git a/packages/opencensus-exporter-stackdriver/src/stackdriver-cloudtrace-utils.ts b/packages/opencensus-exporter-stackdriver/src/stackdriver-cloudtrace-utils.ts
@@ -81,7 +81,9 @@ export function createTimeEvents(
           time: new Date(messageEvent.timestamp).toISOString(),
           messageEvent: {
             id: messageEvent.id,
-            type: createMessageEventType(messageEvent.type)
+            type: createMessageEventType(messageEvent.type),
+            uncompressedSize: String(messageEvent.uncompressedSize || 0),
+            compressedSize: String(messageEvent.compressedSize || 0)
           }
         })));
   }

diff --git a/packages/opencensus-exporter-stackdriver/test/test-stackdriver-cloudtrace-utils.ts b/packages/opencensus-exporter-stackdriver/test/test-stackdriver-cloudtrace-utils.ts
@@ -97,7 +97,13 @@ describe('Stackdriver CloudTrace Exporter Utils', () => {
       {description: 'my_annotation2', timestamp: ts, attributes: {}}
     ];
     const messageEvents: coreTypes.MessageEvent[] = [
-      {id: 'aaaa', timestamp: ts, type: coreTypes.MessageEventType.SENT},
+      {
+        id: 'aaaa',
+        timestamp: ts,
+        type: coreTypes.MessageEventType.SENT,
+        compressedSize: 100,
+        uncompressedSize: 12
+      },
       {id: 'ffff', timestamp: ts, type: coreTypes.MessageEventType.RECEIVED}, {
         id: 'eeee',
         timestamp: ts,
@@ -142,23 +148,21 @@ describe('Stackdriver CloudTrace Exporter Utils', () => {
       },
       {
         messageEvent: {
+          compressedSize: '100',
           id: 'aaaa',
           type: 1,
+          uncompressedSize: '12'
         },
         time: '1970-01-02T10:17:36.789Z',
       },
       {
-        messageEvent: {
-          id: 'ffff',
-          type: 2,
-        },
+        messageEvent:
+            {compressedSize: '0', id: 'ffff', type: 2, uncompressedSize: '0'},
         time: '1970-01-02T10:17:36.789Z',
       },
       {
-        messageEvent: {
-          id: 'eeee',
-          type: 0,
-        },
+        messageEvent:
+            {compressedSize: '0', id: 'eeee', type: 0, uncompressedSize: '0'},
         time: '1970-01-02T10:17:36.789Z',
       }
     ];