From aadf1edad20d36ed33974cc0f106b29fc463209c Mon Sep 17 00:00:00 2001 From: Karen Metts <35154725+karenzone@users.noreply.github.com> Date: Mon, 13 Apr 2020 16:26:38 -0400 Subject: [PATCH] [Doc][Backport] Unit qualifier is required 6.8 (#11780) * Note that unit qualifier is required for config.reload.interval * Update description in logstash.yml --- config/logstash.yml | 3 +++ docs/static/breaking-changes.asciidoc | 1 + docs/static/reloading-config.asciidoc | 4 +++- docs/static/running-logstash-command-line.asciidoc | 1 + docs/static/settings-file.asciidoc | 2 +- 5 files changed, 9 insertions(+), 2 deletions(-) diff --git a/config/logstash.yml b/config/logstash.yml index db8ca3cd00e..4dac1a82527 100644 --- a/config/logstash.yml +++ b/config/logstash.yml @@ -77,6 +77,9 @@ # config.reload.automatic: false # # How often to check if the pipeline configuration has changed (in seconds) +# Note that the unit value (s) is required. Values without a qualifier (e.g. 60) +# are treated as nanoseconds. +# Setting the interval this way is not recommended and might change in later versions. # # config.reload.interval: 3s # diff --git a/docs/static/breaking-changes.asciidoc b/docs/static/breaking-changes.asciidoc index e0e2676253e..9199000721b 100644 --- a/docs/static/breaking-changes.asciidoc +++ b/docs/static/breaking-changes.asciidoc @@ -48,6 +48,7 @@ These changes can impact any instance of Logstash and are plugin agnostic, but o * The setting `config.reload.interval` has been changed to use time value strings such as `5m`, `10s` etc. Previously, users had to convert this to a millisecond time value themselves. + Note that the unit qualifier (`s`) is required. [float] ===== RPM/Deb package changes diff --git a/docs/static/reloading-config.asciidoc b/docs/static/reloading-config.asciidoc index db225a10267..fcb36102086 100644 --- a/docs/static/reloading-config.asciidoc +++ b/docs/static/reloading-config.asciidoc @@ -17,7 +17,9 @@ in configuration settings from the command-line. By default, Logstash checks for configuration changes every 3 seconds. To change this interval, use the `--config.reload.interval ` option, where `interval` specifies how often Logstash -checks the config files for changes. +checks the config files for changes (in seconds). + +Note that the unit qualifier (`s`) is required. If Logstash is already running without auto-reload enabled, you can force Logstash to reload the config file and restart the pipeline by sending a SIGHUP (signal hangup) to the diff --git a/docs/static/running-logstash-command-line.asciidoc b/docs/static/running-logstash-command-line.asciidoc index fb86690b907..08f00aabe2b 100644 --- a/docs/static/running-logstash-command-line.asciidoc +++ b/docs/static/running-logstash-command-line.asciidoc @@ -166,6 +166,7 @@ With this command, Logstash concatenates three config files, `/tmp/one`, `/tmp/t *`--config.reload.interval RELOAD_INTERVAL`*:: How frequently to poll the configuration location for changes. The default value is "3s". + Note that the unit qualifier (`s`) is required. *`--http.host HTTP_HOST`*:: Web API binding host. This option specifies the bind address for the metrics REST endpoint. The default is "127.0.0.1". diff --git a/docs/static/settings-file.asciidoc b/docs/static/settings-file.asciidoc index 306f23e043b..91268317879 100644 --- a/docs/static/settings-file.asciidoc +++ b/docs/static/settings-file.asciidoc @@ -133,7 +133,7 @@ The `logstash.yml` file includes the following settings. If you are using X-Pack | `false` | `config.reload.interval` -| How often in seconds Logstash checks the config files for changes. +| How often in seconds Logstash checks the config files for changes. Note that the unit qualifier (`s`) is required. | `3s` | `config.debug`