Files
OpenSearch-Docs-Cn/_data-prepper/configuration/processors/key-value.md
T
Caroline f64e9dccb4 Restructure Data Prepper plugins documentation (#2073)
* Removed content from Data Prepper reference and broke out into separate pages.

Signed-off-by: carolxob <[email protected]>

* Checking in file to make sure it's the right version.

Signed-off-by: carolxob <[email protected]>

* Minor update.

Signed-off-by: carolxob <[email protected]>

* Updated files.

Signed-off-by: carolxob <[email protected]>

* Adding Sinks file.

Signed-off-by: carolxob <[email protected]>

* Added file to PR.

Signed-off-by: carolxob <[email protected]>

* Corrected TOC hierarchy.

Signed-off-by: carolxob <[email protected]>

* Added images and reorganized files.

Signed-off-by: carolxob <[email protected]>

* Reconfigured some content based on David's feedback.

Signed-off-by: carolxob <[email protected]>

* Modified reference page.

Signed-off-by: carolxob <[email protected]>

* Fixed minor heading issue.

Signed-off-by: carolxob <[email protected]>

* Minor edits.

Signed-off-by: carolxob <[email protected]>

* Major edits, files created, moved, and content broken out from main config page.

Signed-off-by: carolxob <[email protected]>

* Adding key value and processors pages to the PR.

Signed-off-by: carolxob <[email protected]>

* Basic ToC reorg.

Signed-off-by: carolxob <[email protected]>

* ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor update.:

Signed-off-by: carolxob <[email protected]>

* Minor edits to ToC again.

Signed-off-by: carolxob <[email protected]>

* Minor updates.

Signed-off-by: carolxob <[email protected]>

* Minor TOC update

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC edits.

Signed-off-by: carolxob <[email protected]>

* Changed filename.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates

Signed-off-by: carolxob <[email protected]>

* Making small Toc changes.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates.

Signed-off-by: carolxob <[email protected]>

* Added comment blocks for Config and Metrics sections.

Signed-off-by: carolxob <[email protected]>

* Minor ToC updates to add Sinks and Sources under config guide.

Signed-off-by: carolxob <[email protected]>

Signed-off-by: carolxob <[email protected]>
2022-12-27 14:58:48 -08:00

2.3 KiB

layout, title, parent, grand_parent, nav_order
layout title parent grand_parent nav_order
default key_value Processors Configuring Data Prepper 45

key_value

Overview

Takes in a field and parses it into key/value pairs.

Option Required Type Description
source No String The key in the event that is parsed. Default value is message.
destination No String The key where to output the parsed source to. Doing this overwrites the value of the key if it exists. Default value is parsed_message
field_delimiter_regex Conditionally String A regex specifying the delimiter between key/value pairs. Special regex characters such as [ and ] must be escaped using \\. This option cannot be defined at the same time as field_split_characters.
field_split_characters Conditionally String A string of characters to split between key/value pairs. Special regex characters such as [ and ] must be escaped using \\. Default value is &. This option cannot be defined at the same time as field_delimiter_regex.
key_value_delimiter_regex Conditionally String A regex specifying the delimiter between a key and a value. Special regex characters such as [ and ] must be escaped using \\. There is no default value. This option cannot be defined at the same time as value_split_characters.
value_split_characters Conditionally String A string of characters to split between keys and values. Special regex characters such as [ and ] must be escaped using \\. Default value is =. This option cannot be defined at the same time as key_value_delimiter_regex.
non_match_value No String When a key/value cannot be successfully split, the key/value is be placed in the key field and the specified value in the value field. Default value is null.
prefix No String A prefix given to all keys. Default value is empty string.
delete_key_regex No String A regex used to delete characters from the key. Special regex characters such as [ and ] must be escaped using \\. There is no default value.
delete_value_regex No String A regex used to delete characters from the value. Special regex characters such as [ and ] must be escaped using \\. There is no default value.