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

Update replace.asciidoc #25055

Merged
merged 6 commits into from
Apr 20, 2021
Merged
Changes from 5 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
20 changes: 9 additions & 11 deletions libbeat/processors/actions/docs/replace.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@ contains a `field: field-name`, `pattern: regex-pattern` and
`replacement: replacement-string`, where:

* `field` is the original field name
* `pattern` is regex pattern to match field's value
* `replacement` is the replacement string to use for updating the field's value
* `pattern` is the regex pattern to match the field's value
* `replacement` is the replacement string to use to update the field's value

The `replace` processor cannot be used to replace value with a completely new value.

TIP: You can replace field value to truncate part of field value or replace
it with a new string. It can also be used for masking PII information.
TIP: The `replacement` field value can be used to truncate the `field` value or replace
bmorelli25 marked this conversation as resolved.
Show resolved Hide resolved

Following example will change path from /usr/bin to /usr/local/bin
The following example will change path from /usr/bin to /usr/local/bin:

[source,yaml]
-------
Expand All @@ -35,15 +34,14 @@ processors:

The `replace` processor has following configuration settings:

`ignore_missing`:: (Optional) If set to true, no error is logged in case a specifiedfield
is missing. Default is `false`.
`ignore_missing`:: (Optional) If set to `true`, no error is logged if the specified field
is missing. The default is `false`.

`fail_on_error`:: (Optional) If set to true, in case of an error the replacement of
field values is stopped and the original event is returned. If set to false, replacement
continues even if an error occurs during replacement. Default is `true`.
`fail_on_error`:: (Optional) If set to `true` and there's an error, the replacement of
field values is stopped and the original event is returned. If set to `false`, replacement
continues even if an error occurs during replacement. The default is `true`.

See <<conditions>> for a list of supported conditions.

You can specify multiple `ignore_missing` processors under the `processors`
section.