Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Environment variables cannot be in config.string comments. #16689

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Doc: Environment variables cannot be in config.string comments. #16689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6820d47
Doc: Environment variables cannot be in config.string comments due to…
mashhurs Nov 18, 2024
012a05d
Apply suggestions from code review
mashhurs Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/static/env-vars.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<plugin-concepts>>
* Environment variables are immutable. If you update the environment variable, you'll have to restart Logstash to pick up the updated value.
* Environment variables references in `config.string` comments are not allowed. Remove the `$` sign to avoid pipeline config failures.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/static/pipeline-configuration.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ input { # comments can appear at the end of a line, too
# ...
}
----------------------------------

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[]
Expand Down
Loading