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

2.4 KiB

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

date

Overview

Adds a default timestamp to the event or parses timestamp fields, and converts it to ISO 8601 format, which can be used as event timestamp.

Option Required Type Description
match Conditionally List List of key and patterns where patterns is a list. The list of match can have exactly one key and patterns. There is no default value. This option cannot be defined at the same time as from_time_received. Include multiple date processors in your pipeline if both options should be used.
from_time_received Conditionally Boolean A boolean that is used for adding default timestamp to event data from event metadata which is the time when source receives the event. Default value is false. This option cannot be defined at the same time as match. Include multiple date processors in your pipeline if both options should be used.
destination No String Field to store the timestamp parsed by date processor. It can be used with both match and from_time_received. Default value is @timestamp.
source_timezone No String Time zone used to parse dates. It is used in case the zone or offset cannot be extracted from the value. If the zone or offset are part of the value, then timezone is ignored. Find all the available timezones the list of database time zones in the TZ database name column.
destination_timezone No String Timezone used for storing timestamp in destination field. The available timezone values are the same as source_timestamp.
locale No String Locale is used for parsing dates. It's commonly used for parsing month names(MMM). It can have language, country and variant fields using IETF BCP 47 or String representation of Locale object. For example en-US for IETF BCP 47 and en_US for string representation of Locale. Full list of locale fields which includes language, country and variant can be found the language subtag registry. Default value is Locale.ROOT.