Date processor
editDate processor
editParses dates from fields, and then uses the date or timestamp as the timestamp for the document.
By default, the date processor adds the parsed date as a new field called @timestamp
. You can specify a
different field by setting the target_field
configuration parameter. Multiple date formats are supported
as part of the same date processor definition. They will be used sequentially to attempt parsing the date field,
in the same order they were defined as part of the processor definition.
Table 10. Date options
Name | Required | Default | Description |
---|---|---|---|
|
yes |
- |
The field to get the date from. |
|
no |
@timestamp |
The field that will hold the parsed date. |
|
yes |
- |
An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. |
|
no |
UTC |
The timezone to use when parsing the date. Supports template snippets. |
|
no |
ENGLISH |
The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets. |
|
no |
|
The format to use when writing the date to |
|
no |
- |
Conditionally execute this processor. |
|
no |
- |
Handle failures for this processor. See Handling failures in pipelines. |
|
no |
|
Ignore failures for this processor. See Handling failures in pipelines. |
|
no |
- |
An identifier for this processor. Useful for debugging and metrics. |
Here is an example that adds the parsed date to the timestamp
field based on the initial_date
field:
{ "description" : "...", "processors" : [ { "date" : { "field" : "initial_date", "target_field" : "timestamp", "formats" : ["dd/MM/yyyy HH:mm:ss"], "timezone" : "Europe/Amsterdam" } } ] }
The timezone
and locale
processor parameters are templated. This means that their values can be
extracted from fields within documents. The example below shows how to extract the locale/timezone
details from existing fields, my_timezone
and my_locale
, in the ingested document that contain
the timezone and locale values.
{ "description" : "...", "processors" : [ { "date" : { "field" : "initial_date", "target_field" : "timestamp", "formats" : ["ISO8601"], "timezone" : "{{my_timezone}}", "locale" : "{{my_locale}}" } } ] }