From 6820d4783071f9894179a980e3c04a0324893cec Mon Sep 17 00:00:00 2001 From: Mashhur Date: Mon, 18 Nov 2024 15:38:22 -0800 Subject: [PATCH 1/2] Doc: Environment variables cannot be in config.string comments due to substitution logic. --- docs/static/env-vars.asciidoc | 1 + docs/static/pipeline-configuration.asciidoc | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/static/env-vars.asciidoc b/docs/static/env-vars.asciidoc index 56c54e09edb..2c39eddee58 100644 --- a/docs/static/env-vars.asciidoc +++ b/docs/static/env-vars.asciidoc @@ -12,6 +12,7 @@ environment variable is undefined. * You can add environment variable references in any plugin option type: string, number, boolean, array, or hash. * Environment variables for list-type URI parameters can support lists of space-delimited values. Currently, other non-URI based options do not support lists of values. See <> * Environment variables are immutable. If you update the environment variable, you'll have to restart Logstash to pick up the updated value. +* Environment variables in `config.string` comments are not allowed. Remove the `$` sign to avoid pipeline config failures. ==== Examples diff --git a/docs/static/pipeline-configuration.asciidoc b/docs/static/pipeline-configuration.asciidoc index 07c3e5edaf1..1c075c48717 100644 --- a/docs/static/pipeline-configuration.asciidoc +++ b/docs/static/pipeline-configuration.asciidoc @@ -310,7 +310,7 @@ input { # comments can appear at the end of a line, too # ... } ---------------------------------- - +NOTE: Due to a substitution logic, commenting environment `${var}` in `config.string` is not allowed. Remove the `$` sign to avoid pipeline config failures. include::event-data.asciidoc[] include::env-vars.asciidoc[] From 012a05da8bec5a0730361f0c451bf9e0df8a4bd6 Mon Sep 17 00:00:00 2001 From: Mashhur <99575341+mashhurs@users.noreply.github.com> Date: Mon, 2 Dec 2024 09:32:57 -0800 Subject: [PATCH 2/2] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Suggestion to revise the statements. Co-authored-by: João Duarte --- docs/static/env-vars.asciidoc | 2 +- docs/static/pipeline-configuration.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/static/env-vars.asciidoc b/docs/static/env-vars.asciidoc index 2c39eddee58..1b090e1c927 100644 --- a/docs/static/env-vars.asciidoc +++ b/docs/static/env-vars.asciidoc @@ -12,7 +12,7 @@ environment variable is undefined. * You can add environment variable references in any plugin option type: string, number, boolean, array, or hash. * Environment variables for list-type URI parameters can support lists of space-delimited values. Currently, other non-URI based options do not support lists of values. See <> * Environment variables are immutable. If you update the environment variable, you'll have to restart Logstash to pick up the updated value. -* Environment variables in `config.string` comments are not allowed. Remove the `$` sign to avoid pipeline config failures. +* Environment variables references in `config.string` comments are not allowed. Remove the `$` sign to avoid pipeline config failures. ==== Examples diff --git a/docs/static/pipeline-configuration.asciidoc b/docs/static/pipeline-configuration.asciidoc index 1c075c48717..843c3fb5c66 100644 --- a/docs/static/pipeline-configuration.asciidoc +++ b/docs/static/pipeline-configuration.asciidoc @@ -310,7 +310,7 @@ input { # comments can appear at the end of a line, too # ... } ---------------------------------- -NOTE: Due to a substitution logic, commenting environment `${var}` in `config.string` is not allowed. Remove the `$` sign to avoid pipeline config failures. +NOTE: Comments containing environment `${var}` references in `config.string` are not allowed. Remove the `$` sign to avoid pipeline loading failures. include::event-data.asciidoc[] include::env-vars.asciidoc[]