Skip to content

Commit aadf1ed

Browse files
authored
[Doc][Backport] Unit qualifier is required 6.8 (#11780)
* Note that unit qualifier is required for config.reload.interval * Update description in logstash.yml
1 parent bf3282c commit aadf1ed

File tree

5 files changed

+9
-2
lines changed

5 files changed

+9
-2
lines changed

config/logstash.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@
7777
# config.reload.automatic: false
7878
#
7979
# How often to check if the pipeline configuration has changed (in seconds)
80+
# Note that the unit value (s) is required. Values without a qualifier (e.g. 60)
81+
# are treated as nanoseconds.
82+
# Setting the interval this way is not recommended and might change in later versions.
8083
#
8184
# config.reload.interval: 3s
8285
#

docs/static/breaking-changes.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ These changes can impact any instance of Logstash and are plugin agnostic, but o
4848

4949
* The setting `config.reload.interval` has been changed to use time value strings such as `5m`, `10s` etc.
5050
Previously, users had to convert this to a millisecond time value themselves.
51+
Note that the unit qualifier (`s`) is required.
5152

5253
[float]
5354
===== RPM/Deb package changes

docs/static/reloading-config.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ in configuration settings from the command-line.
1717

1818
By default, Logstash checks for configuration changes every 3 seconds. To change this interval,
1919
use the `--config.reload.interval <interval>` option, where `interval` specifies how often Logstash
20-
checks the config files for changes.
20+
checks the config files for changes (in seconds).
21+
22+
Note that the unit qualifier (`s`) is required.
2123

2224
If Logstash is already running without auto-reload enabled, you can force Logstash to
2325
reload the config file and restart the pipeline by sending a SIGHUP (signal hangup) to the

docs/static/running-logstash-command-line.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ With this command, Logstash concatenates three config files, `/tmp/one`, `/tmp/t
166166

167167
*`--config.reload.interval RELOAD_INTERVAL`*::
168168
How frequently to poll the configuration location for changes. The default value is "3s".
169+
Note that the unit qualifier (`s`) is required.
169170

170171
*`--http.host HTTP_HOST`*::
171172
Web API binding host. This option specifies the bind address for the metrics REST endpoint. The default is "127.0.0.1".

docs/static/settings-file.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ The `logstash.yml` file includes the following settings. If you are using X-Pack
133133
| `false`
134134

135135
| `config.reload.interval`
136-
| How often in seconds Logstash checks the config files for changes.
136+
| How often in seconds Logstash checks the config files for changes. Note that the unit qualifier (`s`) is required.
137137
| `3s`
138138

139139
| `config.debug`

0 commit comments

Comments
 (0)