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.

Sign up for GitHub

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

Document auditbeat system process module config #21766

Merged
merged 1 commit into from
Oct 20, 2020
Merged

Document auditbeat system process module config #21766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion x-pack/auditbeat/docs/modules/system.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,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
View file
Open in desktop
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