date
Overview
The date processor adds a default timestamp to an event, parses timestamp fields, and converts timestamp information to the International Organization for Standardization (ISO) 8601 format. This timestamp information can be used as an event timestamp. The following table describes the options you can use to configure the date processor.
| 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. |
Metrics
The following table describes common Abstract processor metrics.
| Metric name | Type | Description |
|---|---|---|
recordsIn | Counter | Metric representing the ingress of records to a pipeline component. |
recordsOut | Counter | Metric representing the egress of records from a pipeline component. |
timeElapsed | Timer | Metric representing the time elapsed during execution of a pipeline component. |
The date processor includes the following custom metrics.
dateProcessingMatchSuccessCounter: Returns the number of records that match with at least one pattern specified by thematch configurationoption.dateProcessingMatchFailureCounter: Returns the number of records that did not match any of the patterns specified by thepatterns matchconfiguration option.