From 57aa0bab60d9c2e4046e709e00369d192e094ab4 Mon Sep 17 00:00:00 2001 From: Katharina Irrgang Date: Mon, 13 Dec 2021 13:21:15 +0100 Subject: [PATCH] fix: removed disableAutomaticTracing legacy config (#432) refs 80206 BREAKING CHANGE: Removed "disableAutomaticTracing" config option. Use `instana({ automaticTracingEnabled: Boolean })`. --- packages/collector/test/tracing/open_tracing/app.js | 3 ++- .../collector/test/tracing/open_tracing/controls.js | 2 +- .../test/tracing/open_tracing/integration_test.js | 2 +- packages/core/src/util/normalizeConfig.js | 6 +----- packages/core/test/util/normalizeConfig_test.js | 12 ------------ 5 files changed, 5 insertions(+), 20 deletions(-) diff --git a/packages/collector/test/tracing/open_tracing/app.js b/packages/collector/test/tracing/open_tracing/app.js index 8dd609bc94..20e6eb5d08 100644 --- a/packages/collector/test/tracing/open_tracing/app.js +++ b/packages/collector/test/tracing/open_tracing/app.js @@ -6,6 +6,7 @@ 'use strict'; const instana = require('../../../'); + instana({ agentPort: process.env.AGENT_PORT, level: 'warn', @@ -13,7 +14,7 @@ instana({ tracing: { enabled: process.env.TRACING_ENABLED !== 'false', forceTransmissionStartingAt: 1, - disableAutomaticTracing: process.env.DISABLE_AUTOMATIC_TRACING === 'true' + automaticTracingEnabled: process.env.DISABLE_AUTOMATIC_TRACING === 'false' } }); diff --git a/packages/collector/test/tracing/open_tracing/controls.js b/packages/collector/test/tracing/open_tracing/controls.js index 997586b6ac..6af4e663fa 100644 --- a/packages/collector/test/tracing/open_tracing/controls.js +++ b/packages/collector/test/tracing/open_tracing/controls.js @@ -24,7 +24,7 @@ exports.registerTestHooks = opts => { env.AGENT_PORT = agentPort; env.APP_PORT = appPort; env.TRACING_ENABLED = opts.enableTracing !== false; - env.DISABLE_AUTOMATIC_TRACING = opts.disableAutomaticTracing === true; + env.DISABLE_AUTOMATIC_TRACING = opts.automaticTracingEnabled === false; expressOpentracingApp = spawn('node', [path.join(__dirname, 'app.js')], { stdio: config.getAppStdio(), diff --git a/packages/collector/test/tracing/open_tracing/integration_test.js b/packages/collector/test/tracing/open_tracing/integration_test.js index 098aa1301e..298d0bfcab 100644 --- a/packages/collector/test/tracing/open_tracing/integration_test.js +++ b/packages/collector/test/tracing/open_tracing/integration_test.js @@ -116,7 +116,7 @@ describe('tracing/opentracing/integration', function () { }); describe('without automatic tracing', () => { - expressOpentracingControls.registerTestHooks({ disableAutomaticTracing: true }); + expressOpentracingControls.registerTestHooks({ automaticTracingEnabled: false }); beforeEach(() => agentControls.waitUntilAppIsCompletelyInitialized(expressOpentracingControls.getPid())); diff --git a/packages/core/src/util/normalizeConfig.js b/packages/core/src/util/normalizeConfig.js index 79f608cc6c..8e96c94dbe 100644 --- a/packages/core/src/util/normalizeConfig.js +++ b/packages/core/src/util/normalizeConfig.js @@ -21,7 +21,6 @@ const supportedTracingVersion = require('../tracing/supportedVersion'); * @property {HTTPTracingOptions} [http] * @property {Array} [disabledTracers] * @property {boolean} [spanBatchingEnabled] - * @property {boolean} [disableAutomaticTracing] * @property {boolean} [disableW3cTraceCorrelation] * @property {KafkaTracingOptions} [kafka] */ @@ -201,7 +200,6 @@ function normalizeTracingEnabled(config) { if (process.env['INSTANA_DISABLE_TRACING'] === 'true') { logger.info('Not enabling tracing as it is explicitly disabled via environment variable INSTANA_DISABLE_TRACING.'); config.tracing.enabled = false; - delete config.tracing.disableAutomaticTracing; return; } @@ -218,10 +216,9 @@ function normalizeAutomaticTracingEnabled(config) { return; } - if (config.tracing.automaticTracingEnabled === false || config.tracing.disableAutomaticTracing) { + if (config.tracing.automaticTracingEnabled === false) { logger.info('Not enabling automatic tracing as it is explicitly disabled via config.'); config.tracing.automaticTracingEnabled = false; - delete config.tracing.disableAutomaticTracing; return; } @@ -230,7 +227,6 @@ function normalizeAutomaticTracingEnabled(config) { 'Not enabling automatic tracing as it is explicitly disabled via environment variable INSTANA_DISABLE_AUTO_INSTR.' ); config.tracing.automaticTracingEnabled = false; - delete config.tracing.disableAutomaticTracing; return; } diff --git a/packages/core/test/util/normalizeConfig_test.js b/packages/core/test/util/normalizeConfig_test.js index 024a075406..070ea1259c 100644 --- a/packages/core/test/util/normalizeConfig_test.js +++ b/packages/core/test/util/normalizeConfig_test.js @@ -96,7 +96,6 @@ describe('util.normalizeConfig', () => { const config = normalizeConfig({ tracing: { enabled: false } }); expect(config.tracing.enabled).to.be.false; expect(config.tracing.automaticTracingEnabled).to.be.false; - expect(config.tracing.disableAutomaticTracing).to.not.exist; }); it('should disable tracing via INSTANA_DISABLE_TRACING', () => { @@ -110,14 +109,6 @@ describe('util.normalizeConfig', () => { const config = normalizeConfig({ tracing: { automaticTracingEnabled: false } }); expect(config.tracing.enabled).to.be.true; expect(config.tracing.automaticTracingEnabled).to.be.false; - expect(config.tracing.disableAutomaticTracing).to.not.exist; - }); - - it('should disable automatic tracing (legacy config)', () => { - const config = normalizeConfig({ tracing: { disableAutomaticTracing: true } }); - expect(config.tracing.enabled).to.be.true; - expect(config.tracing.automaticTracingEnabled).to.be.false; - expect(config.tracing.disableAutomaticTracing).to.not.exist; }); it('should disable automatic tracing via INSTANA_DISABLE_AUTO_INSTR', () => { @@ -125,7 +116,6 @@ describe('util.normalizeConfig', () => { const config = normalizeConfig(); expect(config.tracing.enabled).to.be.true; expect(config.tracing.automaticTracingEnabled).to.be.false; - expect(config.tracing.disableAutomaticTracing).to.not.exist; }); it('should not enable automatic tracing when tracing is disabled in general', () => { @@ -137,7 +127,6 @@ describe('util.normalizeConfig', () => { }); expect(config.tracing.enabled).to.be.false; expect(config.tracing.automaticTracingEnabled).to.be.false; - expect(config.tracing.disableAutomaticTracing).to.not.exist; }); it('should enable immediate tracing activation', () => { @@ -482,7 +471,6 @@ describe('util.normalizeConfig', () => { expect(config.tracing).to.be.an('object'); expect(config.tracing.enabled).to.be.true; expect(config.tracing.automaticTracingEnabled).to.be.true; - expect(config.tracing.disableAutomaticTracing).to.not.exist; expect(config.tracing.activateImmediately).to.be.false; expect(config.tracing.transmissionDelay).to.equal(1000); expect(config.tracing.forceTransmissionStartingAt).to.equal(500);