Caroline f64e9dccb4
Restructure Data Prepper plugins documentation (#2073)
* Removed content from Data Prepper reference and broke out into separate pages.

Signed-off-by: carolxob <carolxob@amazon.com>

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

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor update.

Signed-off-by: carolxob <carolxob@amazon.com>

* Updated files.

Signed-off-by: carolxob <carolxob@amazon.com>

* Adding Sinks file.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added file to PR.

Signed-off-by: carolxob <carolxob@amazon.com>

* Corrected TOC hierarchy.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added images and reorganized files.

Signed-off-by: carolxob <carolxob@amazon.com>

* Reconfigured some content based on David's feedback.

Signed-off-by: carolxob <carolxob@amazon.com>

* Modified reference page.

Signed-off-by: carolxob <carolxob@amazon.com>

* Fixed minor heading issue.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits.

Signed-off-by: carolxob <carolxob@amazon.com>

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

Signed-off-by: carolxob <carolxob@amazon.com>

* Adding key value and processors pages to the PR.

Signed-off-by: carolxob <carolxob@amazon.com>

* Basic ToC reorg.

Signed-off-by: carolxob <carolxob@amazon.com>

* ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor update.:

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits to ToC again.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor TOC update

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Changed filename.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates

Signed-off-by: carolxob <carolxob@amazon.com>

* Making small Toc changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added comment blocks for Config and Metrics sections.

Signed-off-by: carolxob <carolxob@amazon.com>

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

Signed-off-by: carolxob <carolxob@amazon.com>

Signed-off-by: carolxob <carolxob@amazon.com>
2022-12-27 14:58:48 -08:00

34 lines
1.7 KiB
Markdown

---
layout: default
title: grok
parent: Processors
grand_parent: Configuring Data Prepper
nav_order: 45
---
# grok
## Overview
Takes unstructured data and utilizes pattern matching to structure and extract important keys and make data more structured and queryable.
Option | Required | Type | Description
:--- | :--- | :--- | :---
match | No | Map | Specifies which keys to match specific patterns against. Default is an empty body.
keep_empty_captures | No | Boolean | Enables preserving `null` captures. Default value is `false`.
named_captures_only | No | Boolean | enables whether to keep only named captures. Default value is `true`.
break_on_match | No | Boolean | Specifies whether to match all patterns or stop once the first successful match is found. Default is `true`.
keys_to_overwrite | No | List | Specifies which existing keys are to be overwritten if there is a capture with the same key value. Default is `[]`.
pattern_definitions | No | Map | Allows for custom pattern use inline. Default value is an empty body.
patterns_directories | No | List | Specifies the path of directories that contain customer pattern files. Default value is an empty list.
pattern_files_glob | No | String | Specifies which pattern files to use from the directories specified for `pattern_directories`. Default is `*`.
target_key | No | String | Specifies a parent level key to store all captures. Default value is `null`.
timeout_millis | No | Integer | Maximum amount of time that should take place for the matching. Setting to `0` disables the timeout. Default value is `30,000`.
<!---## Configuration
Content will be added to this section.
## Metrics
Content will be added to this section.--->