From 308ed72b049cdb274881f90d5437d0e1896a239a Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 1 Sep 2023 09:32:28 -0700 Subject: [PATCH 1/2] chore: drop old incorrect config envvars --- CHANGELOG.asciidoc | 6 ++++++ docs/upgrade-to-v4.asciidoc | 8 ++++++++ lib/config/schema.js | 10 ++-------- test/config.test.js | 4 ---- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index 27b7794dce..2b38903c1b 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -77,6 +77,12 @@ See the <> guide. These two properties were deprecated in v3.25.0. ({issues}3557[#3557]) +* Remove support for the erroneous `ELASTIC_SANITIZE_FIELD_NAMES` and + `ELASTIC_IGNORE_MESSAGE_QUEUES` config environment variables. The correct env + vars are `ELASTIC_APM_SANITIZE_FIELD_NAMES` and + `ELASTIC_APM_IGNORE_MESSAGE_QUEUES`, respectively, and were supported starting + in v3.36.0. + [float] ===== Features diff --git a/docs/upgrade-to-v4.asciidoc b/docs/upgrade-to-v4.asciidoc index dc5a4cd170..eaf11c4efe 100644 --- a/docs/upgrade-to-v4.asciidoc +++ b/docs/upgrade-to-v4.asciidoc @@ -64,6 +64,14 @@ default. In v4, printing the error to stderr is done by default (to mimic the default Node.js uncaught exception behavior) and there is no option to disable that. +===== `ELASTIC_SANITIZE_FIELD_NAMES`, `ELASTIC_IGNORE_MESSAGE_QUEUES` + +Support for the erroneous `ELASTIC_SANITIZE_FIELD_NAMES` and +`ELASTIC_IGNORE_MESSAGE_QUEUES` config environment variables has been removed. +The correct env vars are `ELASTIC_APM_SANITIZE_FIELD_NAMES` and +`ELASTIC_APM_IGNORE_MESSAGE_QUEUES`, respectively, and were supported starting +in v3.36.0. + [[v4-api-changes]] ==== API changes diff --git a/lib/config/schema.js b/lib/config/schema.js index dd17f02a6d..9d68275e97 100644 --- a/lib/config/schema.js +++ b/lib/config/schema.js @@ -146,10 +146,7 @@ const ENV_TABLE = { disableSend: 'ELASTIC_APM_DISABLE_SEND', environment: 'ELASTIC_APM_ENVIRONMENT', exitSpanMinDuration: 'ELASTIC_APM_EXIT_SPAN_MIN_DURATION', - ignoreMessageQueues: [ - 'ELASTIC_IGNORE_MESSAGE_QUEUES', - 'ELASTIC_APM_IGNORE_MESSAGE_QUEUES', - ], + ignoreMessageQueues: 'ELASTIC_APM_IGNORE_MESSAGE_QUEUES', elasticsearchCaptureBodyUrls: 'ELASTIC_APM_ELASTICSEARCH_CAPTURE_BODY_URLS', errorMessageMaxLength: 'ELASTIC_APM_ERROR_MESSAGE_MAX_LENGTH', errorOnAbortedRequests: 'ELASTIC_APM_ERROR_ON_ABORTED_REQUESTS', @@ -171,10 +168,7 @@ const ENV_TABLE = { metricsLimit: 'ELASTIC_APM_METRICS_LIMIT', opentelemetryBridgeEnabled: 'ELASTIC_APM_OPENTELEMETRY_BRIDGE_ENABLED', payloadLogFile: 'ELASTIC_APM_PAYLOAD_LOG_FILE', - sanitizeFieldNames: [ - 'ELASTIC_SANITIZE_FIELD_NAMES', - 'ELASTIC_APM_SANITIZE_FIELD_NAMES', - ], + sanitizeFieldNames: 'ELASTIC_APM_SANITIZE_FIELD_NAMES', serverCaCertFile: 'ELASTIC_APM_SERVER_CA_CERT_FILE', secretToken: 'ELASTIC_APM_SECRET_TOKEN', serverTimeout: 'ELASTIC_APM_SERVER_TIMEOUT', diff --git a/test/config.test.js b/test/config.test.js index e24df8814f..f6bfcfaae6 100644 --- a/test/config.test.js +++ b/test/config.test.js @@ -2060,10 +2060,6 @@ test('env variable names start with "ELASTIC_APM_" prefix', (t) => { 'KUBERNETES_NODE_NAME', 'KUBERNETES_POD_NAME', 'KUBERNETES_POD_UID', - // These are for backward compatibility -- they were accidentally added - // with the wrong prefix. - 'ELASTIC_SANITIZE_FIELD_NAMES', - 'ELASTIC_IGNORE_MESSAGE_QUEUES', ]; for (const name of names) { if (exclusions.indexOf(name) !== -1) { From ad2296bb9477b8aa18f802b452f3bfa6d5726018 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 1 Sep 2023 12:33:44 -0700 Subject: [PATCH 2/2] update this obsolete old envvar usage too --- test/config.test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/config.test.js b/test/config.test.js index f6bfcfaae6..8ba991f14c 100644 --- a/test/config.test.js +++ b/test/config.test.js @@ -1757,7 +1757,7 @@ test('should accept and normalize ignoreMessageQueues', function (suite) { suite.test('ignoreMessageQueues via env', function (t) { const agent = new Agent(); - process.env.ELASTIC_IGNORE_MESSAGE_QUEUES = 'f*o,bar,baz'; + process.env.ELASTIC_APM_IGNORE_MESSAGE_QUEUES = 'f*o,bar,baz'; agent.start(agentOptsNoopTransport); t.equals( agent._conf.ignoreMessageQueues.length,