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.

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

Cherry-pick #6567 to 6.2: Fix config reload example #6697

Merged
merged 1 commit into from
Mar 29, 2018
Merged
Changes from all commits
Commits
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
10 changes: 4 additions & 6 deletions auditbeat/docs/reload-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ beta[]

You can configure {beatname_uc} to dynamically reload configuration files when
there are changes. To do this, you specify a path
(https://golang.org/pkg/path/filepath/#Glob[Glob]) to watch for module
configuration changes. When the files found by the Glob change, new modules are
(https://golang.org/pkg/path/filepath/#Glob[glob]) to watch for module
configuration changes. When the files found by the glob change, new modules are
started/stopped according to changes in the configuration files.

To enable dynamic config reloading, you specify the `path` and `reload` options
Expand All @@ -20,7 +20,7 @@ auditbeat.config.modules:
reload.period: 10s
------------------------------------------------------------------------------

*`path`*:: A Glob that defines the files to check for changes.
*`path`*:: A glob that defines the files to check for changes.

*`reload.enabled`*:: When set to `true`, enables dynamic config reload.

Expand All @@ -29,13 +29,11 @@ set the `period` to less than 1s because the modification time of files is often
stored in seconds. Setting the `period` to less than 1s will result in
unnecessary overhead.

Each file found by the Glob must contain a list of one or more module
Each file found by the glob must contain a list of one or more module
definitions. For example:

[source,yaml]
------------------------------------------------------------------------------
auditbeat.modules:

- module: file_integrity
paths:
- /www/wordpress
Expand Down