telemetry: add transmit:false flag for logs

Author: tlhunter

packages/dd-trace/src/exporters/agent/writer.js

@@ -42,7 +42,7 @@ class Writer extends BaseWriter {
       startupLog({ agentError: err })
 
       if (err) {
-        log.error('Error sending payload to the agent (status code: %s)', err.status, err)
+        log.error('Error sending payload to the agent (status code: %s)', err.status, { transmit: false }, err)
         done()
         return
       }

packages/dd-trace/src/log/log.js

@@ -3,11 +3,12 @@
 const { format } = require('util')
 
 class Log {
-  constructor (message, args, cause, delegate) {
+  constructor (message, args, cause, delegate, sendViaTelemetry = true) {
     this.message = message
     this.args = args
     this.cause = cause
     this.delegate = delegate
+    this.sendViaTelemetry = sendViaTelemetry
   }
 
   get formatted () {
@@ -22,10 +23,21 @@ class Log {
 
   static parse (...args) {
     let message, cause, delegate
+    let sendViaTelemetry = true
 
-    const lastArg = args.at(-1)
-    if (lastArg && typeof lastArg === 'object' && lastArg.stack) { // lastArg instanceof Error?
-      cause = args.pop()
+    {
+      const lastArg = args.at(-1)
+      if (lastArg && typeof lastArg === 'object' && lastArg.stack) { // lastArg instanceof Error?
+        cause = args.pop()
+      }
+    }
+
+    if (args.length >= 2) {
+      const meta = args.at(-1)
+      if (meta && typeof meta === 'object') {
+        args.pop()
+        sendViaTelemetry = meta.transmit !== false
+      }
     }
 
     const firstArg = args.shift()
@@ -43,7 +55,7 @@ class Log {
       message = String(firstArg)
     }
 
-    return new Log(message, args, cause, delegate)
+    return new Log(message, args, cause, delegate, sendViaTelemetry)
   }
 }
 

packages/dd-trace/src/remote_config/manager.js

@@ -153,7 +153,7 @@ class RemoteConfigManager extends EventEmitter {
       if (statusCode === 404) return cb()
 
       if (err) {
-        log.error('[RC] Error in request', err)
+        log.error('[RC] Error in request', { transmit: false }, err)
         return cb()
       }
 

packages/dd-trace/src/telemetry/logs/log-collector.js

@@ -27,7 +27,7 @@ function createHash (logEntry) {
 }
 
 function isValid (logEntry) {
-  return logEntry?.level && logEntry.message
+  return logEntry?.level && logEntry.message && logEntry.transmit !== false
 }
 
 const EOL = '\n'

packages/dd-trace/test/exporters/agent/writer.spec.js

@@ -147,22 +147,6 @@ function describeWriter (protocolVersion) {
       })
     })
 
-    it('should log request errors', done => {
-      const error = new Error('boom')
-      error.status = 42
-
-      request.yields(error)
-
-      encoder.count.returns(1)
-      writer.flush()
-
-      setTimeout(() => {
-        expect(log.error)
-          .to.have.been.calledWith('Error sending payload to the agent (status code: %s)', error.status, error)
-        done()
-      })
-    })
-
     it('should update sampling rates', (done) => {
       encoder.count.returns(1)
       writer.flush(() => {

packages/dd-trace/test/telemetry/logs/log-collector.spec.js

@@ -49,6 +49,12 @@ describe('telemetry log collector', () => {
       ).to.be.false
     })
 
+    it('should not store logs with transmit flag set to false', () => {
+      expect(logCollector.add({ message: 'Error 1', level: 'ERROR' })).to.be.true
+      expect(logCollector.add({ message: 'Error 2', level: 'ERROR', transmit: true })).to.be.true
+      expect(logCollector.add({ message: 'Error 3', level: 'ERROR', transmit: false })).to.be.false
+    })
+
     it('should include original message and dd frames', () => {
       const ddFrame = `at T (${ddBasePath}path/to/dd/file.js:1:2)`
       const stack = new TypeError('Error 1')