feat: add support for annotations and messageevents to jaeger (#78)

* feature: add support for annotations and messageevents to jaeger

* refactor: lint check

Author: tcolgate

packages/opencensus-exporter-jaeger/src/jaeger-driver/index.ts

@@ -48,16 +48,40 @@ export type SenderCallback = (numSpans: number, err?: string) => void;
  * @param span
  */
 export function spanToThrift(span: Span) {
-  let spanTags = [];
+  const tags = [];
   if (span.attributes) {
-    const tags = [];
     Object.keys(span.attributes).forEach(key => {
       tags.push({'key': key, 'value': span.attributes[key]});
     });
-    spanTags = ThriftUtils.getThriftTags(tags);
   }
 
-  const spanLogs = [];
+  const logs = [];
+  if (span.messageEvents) {
+    span.messageEvents.forEach(msg => {
+      logs.push({
+        timestamp: msg.timestamp,
+        fields: [
+          {'key': 'message.id', 'value': msg.id},
+          {'key': 'message.type', 'value': msg.type}
+        ],
+      });
+    });
+  }
+
+  if (span.annotations) {
+    span.annotations.forEach(ann => {
+      const tags = [];
+      Object.keys(ann.attributes).forEach(key => {
+        tags.push({'key': key, 'value': ann.attributes[key]});
+      });
+      tags.push({'key': 'description', 'value': ann.description});
+      logs.push({
+        timestamp: ann.timestamp,
+        fields: tags,
+      });
+    });
+  }
+
   const unsigned = true;
   const parentSpan = span.parentSpanId ? Utils.encodeInt64(span.parentSpanId) :
                                          ThriftUtils.emptyBuffer;
@@ -67,6 +91,8 @@ export function spanToThrift(span: Span) {
 
   const high = traceId.slice(0, 16);
   const low = traceId.slice(16);
+  const spanTags = ThriftUtils.getThriftTags(tags);
+  const spanLogs = ThriftUtils.getThriftLogs(logs);
 
   return {
     traceIdLow: Utils.encodeInt64(low),

packages/opencensus-exporter-jaeger/test/test-jaeger.ts

@@ -80,11 +80,60 @@ describe('Jaeger Exporter', () => {
     it('should encode as thrift', () => {
       return tracer.startRootSpan({name: 'root-s01'}, (rootSpan) => {
         const span = tracer.startChildSpan('child-s01');
+        span.addAttribute('testBool', true);
+        span.addAttribute('testString', 'here');
+        span.addAttribute('testNum', 3.142);
+        span.addAnnotation('something happened', {
+          'error': true,
+        });
         span.end();
         rootSpan.end();
         const thriftSpan = spanToThrift(span);
         const result = ThriftUtils._thrift.Span.rw.toBuffer(thriftSpan);
         assert.strictEqual(result.err, null);
+
+        assert.strictEqual(thriftSpan.tags.length, 3);
+        let testBoolSeen = false;
+        let testStringSeen = false;
+        let testNumSeen = false;
+        thriftSpan.tags.forEach((tag) => {
+          if (tag.key === 'testBool' && tag.vType === 'BOOL' &&
+              tag.vBool === true) {
+            testBoolSeen = true;
+            return;
+          }
+          if (tag.key === 'testString' && tag.vType === 'STRING' &&
+              tag.vStr === 'here') {
+            testStringSeen = true;
+            return;
+          }
+          if (tag.key === 'testNum' && tag.vType === 'DOUBLE' &&
+              tag.vDouble === 3.142) {
+            testNumSeen = true;
+            return;
+          }
+        });
+
+        assert.strictEqual(true, testBoolSeen && testStringSeen && testNumSeen);
+
+        assert.strictEqual(thriftSpan.logs.length, 1);
+        thriftSpan.logs.forEach((log) => {
+          let descriptionSeen = false;
+          let errorSeen = false;
+          log.fields.forEach((field) => {
+            if (field.key === 'description' && field.vType === 'STRING' &&
+                field.vStr === 'something happened') {
+              descriptionSeen = true;
+              return;
+            }
+            if (field.key === 'error' && field.vType === 'BOOL' &&
+                field.vBool === true) {
+              errorSeen = true;
+              return;
+            }
+            assert.strictEqual(true, descriptionSeen && errorSeen);
+          });
+        });
       });
     });
   });