Skip to content

Commit

Permalink
Add fixes from review
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed Jan 15, 2020
1 parent bec41fb commit 837dae7
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions auditbeat/docs/auditbeat-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,19 @@ You can specify the following options for any {beatname_uc} module.

*`module`*:: The name of the module to run.

*`datasets`*:: A list of datasets to execute. Make sure that you only list datasets that
are available in the module. It is not possible to reference datasets from
other modules.
ifeval::["{modulename}"=="system"]
*`datasets`*:: A list of datasets to execute.
endif::[]

*`enabled`*:: A Boolean value that specifies whether the module is enabled. If you use the
default config file, +{beatname_lc}.yml+, the System module is enabled (set to
`enabled: true`) by default. If the `enabled` option is missing from the
configuration block, the module is enabled by default.
*`enabled`*:: A Boolean value that specifies whether the module is enabled.

ifeval::["{modulename}"=="system"]
*`period`*:: The frequency at which the datasets check for changes. If a system
is not reachable, {beatname_uc} returns an error for each period. This setting
is required.
ifeval::["{modulename}"=="system"]
For most datasets, especially `process` and `socket`, a shorter period is recommended.
is required. For most datasets, especially `process` and `socket`, a shorter
period is recommended.
endif::[]

*`hosts`*:: A list of hosts to fetch information from. For some datasets, such as the
System module, this setting is optional.

*`fields`*:: A dictionary of fields that will be sent with the dataset event. This setting
is optional.

Expand Down

0 comments on commit 837dae7

Please sign in to comment.