refactor log config to a class

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, { transmit: false }, err)
+        log.error('Error sending payload to the agent (status code: %s)', err.status, err, log.MUTE)
         done()
         return
       }

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

@@ -5,7 +5,7 @@ const { inspect } = require('util')
 const { isTrue } = require('../util')
 const { traceChannel, debugChannel, infoChannel, warnChannel, errorChannel } = require('./channels')
 const logWriter = require('./writer')
-const { Log } = require('./log')
+const { Log, LogConfig } = require('./log')
 const { memoize } = require('./utils')
 const { getEnvironmentVariable } = require('../config-helper')
 
@@ -15,7 +15,12 @@ const config = {
   logLevel: 'debug'
 }
 
+const mute = new LogConfig(false)
+
 const log = {
+  LogConfig,
+  MUTE: mute,
+
   /**
    * @returns Read-only version of logging config. To modify config, call `log.use` and `log.toggle`
    */

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

@@ -27,16 +27,16 @@ class Log {
 
     {
       const lastArg = args.at(-1)
-      if (lastArg && typeof lastArg === 'object' && lastArg.stack) { // lastArg instanceof Error?
-        cause = args.pop()
+      if (lastArg instanceof LogConfig) {
+        args.pop()
+        sendViaTelemetry = lastArg.transmit
       }
     }
 
-    if (args.length >= 2) {
-      const meta = args.at(-1)
-      if (meta && typeof meta === 'object') {
-        args.pop()
-        sendViaTelemetry = meta.transmit !== false
+    {
+      const lastArg = args.at(-1)
+      if (lastArg && typeof lastArg === 'object' && lastArg.stack) { // lastArg instanceof Error?
+        cause = args.pop()
       }
     }
 
@@ -59,6 +59,17 @@ class Log {
   }
 }
 
+/**
+ * Pass instances of this class to logger methods when fine-grain control is needed
+ * @property {boolean} transmit - Whether to send the log via telemetry.
+ */
+class LogConfig {
+  constructor (transmit = true) {
+    this.transmit = transmit
+  }
+}
+
 module.exports = {
-  Log
+  Log,
+  LogConfig
 }

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', { transmit: false }, err)
+        log.error('[RC] Error in request', err, log.MUTE)
         return cb()
       }