Skip to content

Commit

Permalink
Update decode_json_fields.asciidoc (#25056)
Browse files Browse the repository at this point in the history
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
  • Loading branch information
3 people authored Apr 21, 2021
1 parent b88ad8d commit cd4d742
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions libbeat/processors/actions/docs/decode_json_fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,23 @@ processors:
The `decode_json_fields` processor has the following configuration settings:

`fields`:: The fields containing JSON strings to decode.
`process_array`:: (Optional) A boolean that specifies whether to process
arrays. The default is false.
`max_depth`:: (Optional) The maximum parsing depth. A value of 1 will decode the
JSON objects in fields indicated in `fields`, a value of 2 will also decode the
objects embedded in the fields of these parsed documents. The default is 1.
`process_array`:: (Optional) A Boolean value that specifies whether to process
arrays. The default is `false`.
`max_depth`:: (Optional) The maximum parsing depth. A value of `1` will decode the
JSON objects in fields indicated in `fields`, a value of `2` will also decode the
objects embedded in the fields of these parsed documents. 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
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 string (`target: ""`). Note that the `null` value (`target:`)
is treated as if the field was not set at all.
`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.
`expand_keys`:: (Optional) A boolean that specifies whether keys in the decoded JSON
should be recursively de-dotted, and expanded into a hierarchical object structure.
is treated as if the field was not set.
`overwrite_keys`:: (Optional) A Boolean value that specifies whether existing keys in the event are overwritten by keys from the decoded JSON object. The
default value is `false`.
`expand_keys`:: (Optional) A Boolean value that specifies whether keys in the decoded JSON
should be recursively de-dotted and expanded into a hierarchical object structure.
For example, `{"a.b.c": 123}` would be expanded into `{"a":{"b":{"c":123}}}`.
`add_error_key`:: (Optional) If it set to true, in case of error while decoding json keys
`error` field is going to be part of event with error message. If it set to false, there
will not be any error in event's field. Even error occurs while decoding json keys. The
default value is false.
`document_id`:: (Optional) JSON key to use as the document id. If configured,
the field will be removed from the original json document and stored in
`add_error_key`:: (Optional) If set to `true` and an error occurs while decoding JSON keys,
the `error` field will become a part of the event with the error message. If set to `false`, there will not be any error in the event's field. The default value is `false`.
`document_id`:: (Optional) JSON key that's used as the document ID. If configured,
the field will be removed from the original JSON document and stored in
`@metadata._id`

0 comments on commit cd4d742

Please sign in to comment.