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 key value processor documentation with new config options #7413

Merged
merged 9 commits into from
Jun 24, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ You can use the `key_value` processor to parse the specified field into key-valu
| tags_on_failure | When a `kv` operation causes a runtime exception within the processor, the operation is safely stopped without crashing the processor, and the event is tagged with the provided tags. | If `tags_on_failure` is set to `["keyvalueprocessor_failure"]`, `{"tags": ["keyvalueprocessor_failure"]}` will be added to the event's metadata in the event of a runtime exception. |
| value_grouping | Specifies whether to group values using predefined value grouping delimiters: `{...}`, `[...]', `<...>`, `(...)`, `"..."`, `'...'`, `http://... (space)`, and `https:// (space)`. If this flag is enabled, then the content between the delimiters is considered to be one entity and is not parsed for key-value pairs. Default is `false`. If `value_grouping` is `true`, then `{"key1=[a=b,c=d]&key2=value2"}` parses to `{"key1": "[a=b,c=d]", "key2": "value2"}`. |
| drop_keys_with_no_value | Specifies whether keys should be dropped if they have a null value. Default is `false`. If `drop_keys_with_no_value` is set to `true`, then `{"key1=value1&key2"}` parses to `{"key1": "value1"}`. |
| strict_grouping | Specifies whether strict grouping should be enabled when `value_grouping` or `string_literal_character` options are used. Default is `false`. | If enabled, groups with unmatched end characters results in errors. The event is ignored after error is logged. |
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
| string_literal_character | A single quote(`'`) or double quote(`"`) can be configured as string literal character. Default is Null. | If this option is used, the text between the single/double quote is ignored and is not used for key value parsing. An input like `text1 "key1=value1" text2 key2=value2` parses to `{"key2": "value2"}`.|
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
| key_value_when | A [conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/), such as `/some-key == "test"'`. that will be evaluated to determine whether the processor will be run on the event. |
vagimeli marked this conversation as resolved.
Show resolved Hide resolved



Expand Down
Loading