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

Add new options to decode_json_fields processor docs #3512

Merged
merged 1 commit into from
Feb 3, 2017
Merged

Add new options to decode_json_fields processor docs #3512

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
9 changes: 9 additions & 0 deletions libbeat/docs/processors-config.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,8 @@ processors:
fields: ["field1", "field2", ...]
process_array: false
max_depth: 1
target:
overwrite_keys: false
-----------------------------------------------------

The `decode_json_fields` processor has the following configuration settings:
Expand All @@ -361,6 +363,13 @@ The `decode_json_fields` processor has the following configuration settings:
`process_array`:: (Optional) A boolean that specifies whether to process
arrays. The default is false.
`max_depth`:: (Optional) The maximum parsing depth. The default is 1.
`target`:: (Optional) The field under which the decoded JSON will be written. By
default the decoded JSON object replaces the string field from which it was
read. To merge the decoded JSON fields into the root of the event, specify
`target` with an empty value (`target:`).
`overwrite_keys`:: (Optional) A boolean that specifies whether keys that already
exist in the event are overwritten by keys from the decoded JSON object. The
default value is false.

[[drop-event]]
=== drop_event
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/processors.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//// Use the appropriate variables defined in the index.asciidoc file to
//// resolve Beat names: beatname_uc and beatname_lc.
//// Use the following include to pull this content into a doc file:
//// include::../../libbeat/docs/filtering.asciidoc[]
//// include::../../libbeat/docs/processors.asciidoc[]
//////////////////////////////////////////////////////////////////////////

You can define processors in your configuration to process events before they
Expand Down