Skip to content

Commit

Permalink
Document auditbeat system process module config (elastic#21766)
Browse files Browse the repository at this point in the history
The documentation for the system/process dataset was missing information
on the configuration options.

Closes elastic#16869

(cherry picked from commit e0d0654)
  • Loading branch information
andrewkroh committed Oct 20, 2020
1 parent 6ac81f7 commit 0b463d4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
2 changes: 1 addition & 1 deletion x-pack/auditbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ This module also supports the
<<module-standard-options-{modulename},standard configuration options>>
described later.

*`state.period`*:: The frequency at which the datasets send full state information.
*`state.period`*:: The interval at which the datasets send full state information.
This option can be overridden per dataset using `{dataset}.state.period`.

*`user.detect_password_changes`*:: If the `user` dataset is configured and
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ This module also supports the
<<module-standard-options-{modulename},standard configuration options>>
described later.

*`state.period`*:: The frequency at which the datasets send full state information.
*`state.period`*:: The interval at which the datasets send full state information.
This option can be overridden per dataset using `{dataset}.state.period`.

*`user.detect_password_changes`*:: If the `user` dataset is configured and
Expand Down
22 changes: 21 additions & 1 deletion x-pack/auditbeat/module/system/process/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,30 @@

beta[]

This is the `process` dataset of the system module.
This is the `process` dataset of the system module. It generates an event when
a process starts and stops.

It is implemented for Linux, macOS (Darwin), and Windows.

[float]
=== Configuration options

*`process.state.period`*:: The interval at which the dataset sends full state
information. If set this will take precedence over `state.period`. The default
value is `12h`.

*`process.hash.max_file_size`*:: The maximum size of a file in bytes for which
{beatname_uc} will compute hashes. Files larger than this size will not be
hashed. The default value is 100 MiB. For convenience units can be specified as
a suffix to the value. The supported units are `b` (default), `kib`, `kb`,
`mib`, `mb`, `gib`, `gb`, `tib`, `tb`, `pib`, `pb`, `eib`, and `eb`.

*`process.hash.hash_types`*:: A list of hash types to compute when the file
changes. The supported hash types are `blake2b_256`, `blake2b_384`,
`blake2b_512`, `md5`, `sha1`, `sha224`, `sha256`, `sha384`, `sha512`,
`sha512_224`, `sha512_256`, `sha3_224`, `sha3_256`, `sha3_384`, `sha3_512`, and
`xxh64`. The default value is `sha1`.

[float]
==== Example dashboard

Expand Down

0 comments on commit 0b463d4

Please sign in to comment.