feat: only add host tag to profiles when DD_TRACE_REPORT_HOSTNAME is set (#7494)

Author: szegedi

packages/dd-trace/src/profiling/config.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const os = require('os')
 const path = require('path')
 const { pathToFileURL } = require('url')
 
@@ -53,7 +52,6 @@ class Config {
       DD_TAGS,
     } = getProfilingEnvValues()
 
-    const host = os.hostname()
     // Must be longer than one minute so pad with five seconds
     const flushInterval = options.interval ?? (Number(DD_PROFILING_UPLOAD_PERIOD) * 1000 || 65 * 1000)
     const uploadTimeout = options.uploadTimeout ?? (Number(DD_PROFILING_UPLOAD_TIMEOUT) || 60 * 1000)
@@ -62,7 +60,6 @@ class Config {
     // TODO: Remove the fallback. Just use the value from the config.
     this.service = options.service || 'node'
     this.env = options.env
-    this.host = host
     this.functionname = AWS_LAMBDA_FUNCTION_NAME
 
     this.version = options.version
@@ -71,7 +68,7 @@ class Config {
       tagger.parse(options.tags),
       tagger.parse({
         env: options.env,
-        host,
+        host: options.reportHostname ? require('os').hostname() : undefined,
         service: this.service,
         version: this.version,
         functionname: AWS_LAMBDA_FUNCTION_NAME,

packages/dd-trace/src/profiling/profiler.js

@@ -76,6 +76,7 @@ class Profiler extends EventEmitter {
       repositoryUrl,
       commitSHA,
       injectionEnabled,
+      reportHostname,
     } = config
     const { enabled, sourceMap, exporters } = config.profiling
     const { heartbeatInterval } = config.telemetry
@@ -112,6 +113,7 @@ class Profiler extends EventEmitter {
       libraryInjected,
       activation,
       heartbeatInterval,
+      reportHostname,
     }
 
     return this._start(options).catch((err) => {

packages/dd-trace/test/profiling/config.spec.js

@@ -71,7 +71,6 @@ describe('config', () => {
 
     assert.deepStrictEqual(config.tags, {
       service: 'node',
-      host: os.hostname(),
     })
 
     assert.ok(config.logger instanceof ConsoleLogger)
@@ -94,12 +93,13 @@ describe('config', () => {
       profilers: 'space,wall',
       url: 'http://localhost:1234/',
       codeHotspotsEnabled: false,
+      reportHostname: true,
     }
 
     const config = new Config(options)
 
     assert.strictEqual(config.service, options.service)
-    assert.strictEqual(typeof config.host, 'string')
+    assert.strictEqual(typeof config.tags.host, 'string')
     assert.strictEqual(config.version, options.version)
     assert.ok(typeof config.tags === 'object' && config.tags !== null)
     assert.strictEqual(typeof config.tags.host, 'string')
@@ -121,6 +121,28 @@ describe('config', () => {
     }
   })
 
+  it('should not include host tag when reportHostname is false', () => {
+    const config = new Config({ reportHostname: false })
+
+    assert.strictEqual(config.tags.host, undefined)
+    assert.ok(!('host' in config.tags))
+  })
+
+  it('should not include host tag when reportHostname is not set', () => {
+    const config = new Config({})
+
+    assert.strictEqual(config.tags.host, undefined)
+    assert.ok(!('host' in config.tags))
+  })
+
+  it('should include host tag when reportHostname is true', () => {
+    const config = new Config({ reportHostname: true })
+
+    assert.strictEqual(typeof config.tags.host, 'string')
+    assert.ok(config.tags.host.length > 0)
+    assert.strictEqual(config.tags.host, os.hostname())
+  })
+
   it('should filter out invalid profilers', () => {
     const errors = []
     const options = {
@@ -444,7 +466,7 @@ describe('config', () => {
   })
 
   it('should enable OOM heap profiler by default and use process as default strategy', () => {
-    const config = new Config()
+    const config = new Config({ reportHostname: true })
 
     if (oomMonitoringSupported) {
       assert.deepStrictEqual(config.oomMonitoring, {
@@ -456,7 +478,7 @@ describe('config', () => {
           process.execPath,
           path.normalize(path.join(__dirname, '../../src/profiling', 'exporter_cli.js')),
           'http://127.0.0.1:8126/',
-          `host:${config.host},service:node,snapshot:on_oom`,
+          `host:${config.tags.host},service:node,snapshot:on_oom`,
           'space',
         ],
       })
@@ -513,7 +535,7 @@ describe('config', () => {
         DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES: 'process,async,process',
       }
 
-      const config = new Config({})
+      const config = new Config({ reportHostname: true })
 
       assert.deepStrictEqual(config.oomMonitoring, {
         enabled: true,
@@ -524,7 +546,7 @@ describe('config', () => {
           process.execPath,
           path.normalize(path.join(__dirname, '../../src/profiling', 'exporter_cli.js')),
           'http://127.0.0.1:8126/',
-          `host:${config.host},service:node,snapshot:on_oom`,
+          `host:${config.tags.host},service:node,snapshot:on_oom`,
           'space',
         ],
       })