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

1.9 KiB
Raw Blame History

layout title parent grand_parent nav_order
default csv Processors Configuring Data Prepper 45

csv

Overview

Takes in an Event and parses its CSV data into columns.

Option Required Type Description
source No String The field in the Event that will be parsed. Default is message.
quote_character No String The character used as a text qualifier for a single column of data. Default is double quote ".
delimiter No String The character separating each column. Default is ,.
delete_header No Boolean If specified, the header on the Event (column_names_source_key) deletes after the event is parsed. If theres no header on the event, no actions is taken. Default is true.
column_names_source_key No String The field in the Event that specifies the CSV column names, which will be autodetected. If there must be extra column names, the column names autogenerate according to their index. If column_names is also defined, the header in column_names_source_key can also be used to generate the event fields. If too few columns are specified in this field, the remaining column names autogenerate. If too many column names are specified in this field, the CSV processor omits the extra column names.
column_names No List User-specified names for the CSV columns. Default is [column1, column2, ..., columnN] if there are N columns of data in the CSV record and column_names_source_key is not defined. If column_names_source_key is defined, the header in column_names_source_key generates the Event fields. If too few columns are specified in this field, the remaining column names will autogenerate. If too many column names are specified in this field, CSV processor omits the extra column names.