More beautiful debug logs (#3171)

Author: juan-fernandez

packages/dd-trace/src/ci-visibility/exporters/agentless/coverage-writer.js

@@ -1,16 +1,11 @@
 'use strict'
 const request = require('../../../exporters/common/request')
 const log = require('../../../log')
+const { safeJSONStringify } = require('../../../exporters/common/util')
 
 const { CoverageCIVisibilityEncoder } = require('../../../encode/coverage-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
 
-function safeJSONStringify (value) {
-  return JSON.stringify(value, (key, value) =>
-    key !== 'dd-api-key' ? value : undefined
-  )
-}
-
 class Writer extends BaseWriter {
   constructor ({ url, evpProxyPrefix = '' }) {
     super(...arguments)

packages/dd-trace/src/ci-visibility/exporters/agentless/writer.js

@@ -1,16 +1,11 @@
 'use strict'
 const request = require('../../../exporters/common/request')
+const { safeJSONStringify } = require('../../../exporters/common/util')
 const log = require('../../../log')
 
 const { AgentlessCiVisibilityEncoder } = require('../../../encode/agentless-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
 
-function safeJSONStringify (value) {
-  return JSON.stringify(value, (key, value) =>
-    key !== 'dd-api-key' ? value : undefined
-  )
-}
-
 class Writer extends BaseWriter {
   constructor ({ url, tags, evpProxyPrefix = '' }) {
     super(...arguments)

packages/dd-trace/src/exporters/common/util.js

@@ -0,0 +1,9 @@
+function safeJSONStringify (value) {
+  return JSON.stringify(
+    value,
+    (key, value) => key !== 'dd-api-key' ? value : undefined,
+    process.env.DD_TRACE_BEAUTIFUL_LOGS ? 2 : undefined
+  )
+}
+
+module.exports = { safeJSONStringify }

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

@@ -2,6 +2,7 @@
 
 const request = require('./request')
 const log = require('../../log')
+const { safeJSONStringify } = require('./util')
 
 class Writer {
   constructor ({ url }) {
@@ -25,11 +26,11 @@ class Writer {
 
   append (payload) {
     if (!request.writable) {
-      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${JSON.stringify(payload)}`)
+      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${safeJSONStringify(payload)}`)
       return
     }
 
-    log.debug(() => `Encoding payload: ${JSON.stringify(payload)}`)
+    log.debug(() => `Encoding payload: ${safeJSONStringify(payload)}`)
 
     this._encode(payload)
   }