feat: Added profiling configuration (#3733)

Author: svetlanabrennan

lib/config/default.js

@@ -1253,6 +1253,47 @@ defaultConfig.definition = () => {
         default: true
       }
     },
+    /**
+     * Controls the behavior of the profiler.
+     */
+    profiling: {
+      enabled: {
+        formatter: boolean,
+        default: false
+      },
+      /**
+       * Harvest and ingest profile data every n milliseconds
+       */
+      sample_interval_ms: {
+        formatter: int,
+        default: 100
+      },
+      /**
+       * List of profile type names to enable. Only cpu and heap profiles are currently supported
+       */
+      include: {
+        formatter: array,
+        default: ['cpu', 'heap']
+      },
+      /**
+       * Restart the cpu profiler every n milliseconds to report its data
+       */
+      cpu: {
+        report_interval_ms: {
+          formatter: int,
+          default: 0
+        }
+      },
+      /**
+       * Restart heap profiler every n milliseconds to report its data
+       */
+      heap: {
+        report_interval_ms: {
+          formatter: int,
+          default: 0
+        }
+      }
+    },
 
     /**
      * When `true`, the AWS Lambda instrumentation will add the necessary

test/unit/config/config-defaults.test.js

@@ -346,6 +346,14 @@ test('with default properties', async (t) => {
     })
   })
 
+  await t.test('profiling defaults', () => {
+    assert.equal(configuration.profiling.enabled, false)
+    assert.equal(configuration.profiling.sample_interval_ms, 100)
+    assert.deepEqual(configuration.profiling.include, ['cpu', 'heap'])
+    assert.equal(configuration.profiling.cpu.report_interval_ms, 0)
+    assert.equal(configuration.profiling.heap.report_interval_ms, 0)
+  })
+
   await t.test('opentelemetry', () => {
     const otel = configuration.opentelemetry
     assert.equal(otel.enabled, false)

test/unit/config/config-env.test.js

@@ -479,6 +479,23 @@ test('when overriding configuration values via environment variables', async (t)
     end()
   })
 
+  await t.test('should set the profiling options', (t, end) => {
+    const env = {
+      NEW_RELIC_PROFILING_ENABLED: true,
+      NEW_RELIC_PROFILING_INCLUDE: ['heap'],
+      NEW_RELIC_PROFILING_SAMPLE_INTERVAL_MS: 150,
+      NEW_RELIC_PROFILING_HEAP_REPORT_INTERVAL_MS: 200
+    }
+
+    idempotentEnv(env, (tc) => {
+      assert(tc.profiling.enabled, true)
+      assert.deepStrictEqual(tc.profiling.include, ['heap'])
+      assert.equal(tc.profiling.sample_interval_ms, 150)
+      assert.equal(tc.profiling.heap.report_interval_ms, 200)
+      end()
+    })
+  })
+
   await t.test('should pick up the log filepath', (t, end) => {
     idempotentEnv({ NEW_RELIC_LOG: '/highway/to/the/danger/zone' }, (tc) => {
       assert.equal(tc.logging.filepath, '/highway/to/the/danger/zone')

test/unit/config/config.test.js

@@ -537,4 +537,23 @@ test('distributed tracing samplers', async (t) => {
     assert.equal(configuration.distributed_tracing.sampler.partial_granularity.enabled, true)
     assert.equal(configuration.distributed_tracing.sampler.partial_granularity.type, 'reduced')
   })
+
+  await t.test('should set cpu profiling options', () => {
+    const config = {
+      profiling: {
+        enabled: true,
+        sample_interval_ms: 200,
+        include: ['cpu'],
+        cpu: {
+          report_interval_ms: 50
+        }
+      }
+    }
+
+    const configuration = Config.initialize(config)
+    assert.equal(configuration.profiling.enabled, true)
+    assert.equal(configuration.profiling.sample_interval_ms, 200)
+    assert.deepEqual(configuration.profiling.include, ['cpu'])
+    assert.equal(configuration.profiling.cpu.report_interval_ms, 50)
+  })
 })