Merge pull request #20091 from mozilla/polish-sentry-traceid-on-logs

polish(auth): sentry traceid on logs

Author: dschom

packages/fxa-auth-server/lib/log.js

@@ -64,16 +64,30 @@ util.inherits(Lug, EventEmitter);
 Lug.prototype.close = function () {};
 
 Lug.prototype.getTraceId = function (data) {
-  let result = {};
+  const result = {};
 
-  if (this.nodeTracer) {
-    try {
-      result = { traceId: this.nodeTracer.getTraceId() };
-    } catch {
-      // don't let a tracing issue break logging
-      this.debug('log', { msg: 'could not get trace id' });
+  // Try decorating result with otel traceId
+  try {
+    const otelTraceId = this.nodeTracer?.getTraceId();
+    if (otelTraceId) {
+      result.otelTraceId = otelTraceId;
     }
+  } catch (err) {
+    // Don't let a hiccup break logging
+    result.otelTraceIdErr = err;
   }
+
+  // Try decorating result with sentry trace id
+  try {
+    const spanContext = Sentry.getActiveSpan()?.spanContext();
+    if (spanContext) {
+      result.sentryTraceId = spanContext.traceId;
+    }
+  } catch (err) {
+    // Don't let a hiccup break logging
+    result.sentryTraceIdError = err;
+  }
+
   return result;
 };
 

packages/fxa-auth-server/test/local/log.js

@@ -46,6 +46,7 @@ describe('log', () => {
         sentryScope = { setContext: sinon.stub() };
         cb(sentryScope);
       }),
+      getActiveSpan: sinon.stub().returns(undefined),
     };
     sinon.stub(sentryModule, 'reportSentryMessage').returns({});
 
@@ -795,7 +796,7 @@ describe('log', () => {
       assert.calledOnceWithExactly(logger.info, 'op', { uid: 'bloop' });
     });
 
-    it('should set trace id', () => {
+    it('should set otel trace id', () => {
       log = proxyquire(
         '../../lib/log',
         mocks
@@ -813,23 +814,83 @@ describe('log', () => {
       });
       assert.calledOnceWithExactly(logger.info, 'op', {
         uid: 'bloop',
-        traceId: 'fake trace id',
+        otelTraceId: 'fake trace id',
       });
 
       log.debug('op', {
         uid: 'bloop',
       });
       assert.calledOnceWithExactly(logger.debug, 'op', {
         uid: 'bloop',
-        traceId: 'fake trace id',
+        otelTraceId: 'fake trace id',
       });
 
       log.error('op', {
         uid: 'bloop',
       });
       assert.calledOnceWithExactly(logger.error, 'op', {
         uid: 'bloop',
-        traceId: 'fake trace id',
+        otelTraceId: 'fake trace id',
+      });
+    });
+
+    it('should set sentry trace id', () => {
+      mockSentry.getActiveSpan = sinon.stub().returns({
+        spanContext: sinon.stub().returns({ traceId: 'fake-sentry-trace-id' }),
+      });
+      log = proxyquire(
+        '../../lib/log',
+        mocks
+      )({
+        level: 'debug',
+        name: 'test',
+        stdout: { on: sinon.spy() },
+      });
+
+      log.info('op', { uid: 'bloop' });
+      assert.calledOnceWithExactly(logger.info, 'op', {
+        uid: 'bloop',
+        sentryTraceId: 'fake-sentry-trace-id',
+      });
+    });
+
+    it('should store otel error in result on failure', () => {
+      const otelErr = new Error('otel error');
+      log = proxyquire(
+        '../../lib/log',
+        mocks
+      )({
+        level: 'debug',
+        name: 'test',
+        stdout: { on: sinon.spy() },
+        nodeTracer: {
+          getTraceId: sinon.stub().throws(otelErr),
+        },
+      });
+
+      log.info('op', { uid: 'bloop' });
+      assert.calledOnceWithExactly(logger.info, 'op', {
+        uid: 'bloop',
+        otelTraceIdErr: otelErr,
+      });
+    });
+
+    it('should store sentry error in result on failure', () => {
+      const sentryErr = new Error('sentry error');
+      mockSentry.getActiveSpan = sinon.stub().throws(sentryErr);
+      log = proxyquire(
+        '../../lib/log',
+        mocks
+      )({
+        level: 'debug',
+        name: 'test',
+        stdout: { on: sinon.spy() },
+      });
+
+      log.info('op', { uid: 'bloop' });
+      assert.calledOnceWithExactly(logger.info, 'op', {
+        uid: 'bloop',
+        sentryTraceIdError: sentryErr,
       });
     });
   });