:plugin: date
:type: filter

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Date filter plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

The date filter is used for parsing dates from fields, and then using that date or timestamp as the logstash timestamp for the event.
Timestamp is stored with millisecond precision. Set `precision => "ns"` to preserve nanoseconds.

Custom parsing formats use the JVM’s default locale and time zone.
To override them, configure the `locale` and `timezone` settings.

[id="plugins-{type}s-{plugin}-options"]
==== Date Filter Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-locale>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-match>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-precision>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-timezone>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
filter plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-locale"]
===== `locale` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Specify a locale to be used for date parsing using either IETF-BCP47 or POSIX language tag.
Simple examples are `en`,`en-US` for BCP47 or `en_US` for POSIX.

The locale is mostly necessary to be set for parsing month names (pattern with `MMM`) and
weekday names (pattern with `EEE`).

If not specified, the platform default will be used but for non-english platform default
an english parser will also be used as a fallback mechanism.

[id="plugins-{type}s-{plugin}-match"]
===== `match` 

  * Value type is <<array,array>>
  * Default value is `[]`

An array with field name first, and format patterns following, `[ field,
formats... ]`

If your time field has multiple possible formats, you can do this:
[source,ruby]
    match => [ "logdate", "MMM dd yyyy HH:mm:ss",
              "MMM  d yyyy HH:mm:ss", "ISO8601" ]

The above will match a syslog (rfc3164) or `iso8601` timestamp.

By default, the custom formats use the deprecated https://www.joda.org/joda-time/key_format.html[joda-time] library for parsing and timestamp is stored with millisecond precision.
If you set `precision => "ns"`, parsing is performed using https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html[java.time], and timestamps are stored with nanosecond precision.
Both libraries use similar syntax, but there are some differences in supported features. For example, `java.time` supports time zone IDs with `VV` while `joda-time` uses `ZZZ`.

Besides custom formats, the following format literals exist
to help you save time and ensure correctness of date parsing.

* `ISO8601` - should parse any valid ISO8601 timestamp, such as `2011-04-19T03:44:01.123456789Z`
* `UNIX` - will parse *float or int* value expressing unix time in seconds since epoch like 1326149001.132 as well as 1326149001
* `UNIX_MS` - will parse **int** value expressing unix time in milliseconds since epoch like 1366125117000
* `TAI64N` - will parse tai64n time values

For example, if you have a field `logdate`, with a value that looks like
`Aug 13 2010 00:03:44`, you would use this configuration:
[source,ruby]
    filter {
      date {
        match => [ "logdate", "MMM dd yyyy HH:mm:ss" ]
      }
    }

If your field is nested in your structure, you can use the nested
syntax `[foo][bar]` to match its value. For more information, please refer to
<<logstash-config-field-references>>

*More details on the syntax*

The syntax used for parsing date and time text uses letters to indicate the
kind of time value (month, minute, etc), and a repetition of letters to
indicate the form of that value (2-digit month, full month name, etc).

Here's what you can use to parse dates and times:

* `y`: year
** `yyyy`: full year number. Example: `2015`.
** `yy`: two-digit year. Example: `15` for the year 2015.

* `M`: month of the year
** `M`: minimal-digit month. Example: `1` for January and `12` for December.
** `MM`: two-digit month. zero-padded if needed. Example: `01` for January  and `12` for December
** `MMM`: abbreviated month text. Example: `Jan` for January. Note: The language used depends on your locale. See the `locale` setting for how to change the language.
** `MMMM`: full month text, Example: `January`. Note: The language used depends on your locale.

* `d`: day of the month
** `d`: minimal-digit day. Example: `1` for the 1st of the month.
** `dd`: two-digit day, zero-padded if needed. Example: `01` for the 1st of the month.

* `H`: hour of the day (24-hour clock)
** `H`: minimal-digit hour. Example: `0` for midnight.
** `HH`: two-digit hour, zero-padded if needed. Example: `00` for midnight.

* `m`: minutes of the hour (60 minutes per hour)
** `m`: minimal-digit minutes. Example: `0`.
** `mm`: two-digit minutes, zero-padded if needed. Example: `00`.

* `s`: seconds of the minute (60 seconds per minute)
** `s`: minimal-digit seconds. Example: `0`.
** `ss`: two-digit seconds, zero-padded if needed. Example: `00`.

* `S`: fraction of a second
** `S`: tenths of a second. Example:  `0` for a subsecond value `012`
** `SS`: hundredths of a second. Example:  `01` for a subsecond value `01`
** `SSS`: milliseconds. Example:  `012` for a subsecond value `012`
** `SSSSSS`: microseconds. Example:  `012345`
** `SSSSSSSSS`: nanoseconds. Example:  `012345678`

* `V`: time-zone ID
** `VV`: time zone ID. Example: `America/Los_Angeles`. Note: This is only supported by `java.time` parsing.

* `Z`: time zone offset or identity
** `Z`: Timezone offset structured as HHmm (hour and minutes offset from Zulu/UTC). Example: `-0700`.
** `ZZ`: Timezone offset structured as HH:mm (colon in between hour and minute offsets). Example: `-07:00`.
** `ZZZ`: Timezone identity. Example: `America/Los_Angeles`. Note: Valid IDs are listed on the http://joda-time.sourceforge.net/timezones.html[Joda.org available time zones page].

* `z`: time zone names. *Time zone names (`z`) cannot be parsed.*

* `w`: week of the year
** `w`: minimal-digit week. Example: `1`.
** `ww`: two-digit week, zero-padded if needed. Example: `01`.

* `D`: day of the year

* `e`: day of the week (number)

* `E`: day of the week (text)
** `E`, `EE`, `EEE`: Abbreviated day of the week. Example:  `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat`, `Sun`. Note: The actual language of this will depend on your locale.
** `EEEE`: The full text day of the week. Example: `Monday`, `Tuesday`, ... Note: The actual language of this will depend on your locale.

For non-formatting syntax, you'll need to put single-quote characters around the value. For example, if you were parsing ISO8601 time, "2015-01-01T01:12:23" that little "T" isn't a valid time format, and you want to say "literally, a T", your format would be this: "yyyy-MM-dd'T'HH:mm:ss"

Other less common date units, such as era (G), century \(C), am/pm (a), and # more, can be learned about on the
https://www.joda.org/joda-time/key_format.html[joda-time documentation].

[id="plugins-{type}s-{plugin}-precision"]
===== `precision`

  * Value type is <<string,string>>
  * Valid values are `ms` and `ns`
  * Default value is `ms`

Controls the sub-second precision of the stored timestamp.

`ms` stores data in millisecond precision. Custom pattern formats use https://www.joda.org/joda-time/key_format.html[joda-time] parsing rules. For example, `yyyy-MM-dd HH:mm:ss ZZZ`.

`ns` stores data in nanosecond precision. Custom pattern formats use https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html[java.time] parsing rules. For example, `yyyy-MM-dd HH:mm:ss VV`.

[id="plugins-{type}s-{plugin}-tag_on_failure"]
===== `tag_on_failure`

  * Value type is <<array,array>>
  * Default value is `["_dateparsefailure"]`

Append values to the `tags` field when there has been no
successful match

[id="plugins-{type}s-{plugin}-target"]
===== `target` 

  * Value type is <<string,string>>
  * Default value is `"@timestamp"`

Store the matching timestamp into the given target field.  If not provided,
default to updating the `@timestamp` field of the event.

[id="plugins-{type}s-{plugin}-timezone"]
===== `timezone` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Specify a time zone canonical ID to be used for date parsing.
The valid IDs are listed on the http://joda-time.sourceforge.net/timezones.html[Joda.org available time zones page].
This is useful in case the time zone cannot be extracted from the value,
and is not the platform default.
If this is not specified the platform default will be used.
Canonical ID is good as it takes care of daylight saving time for you
For example, `America/Los_Angeles` or `Europe/Paris` are valid IDs.
This field can be dynamic and include parts of the event using the `%{field}` syntax



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]