logstash-filter-date 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea85b9a739ee3c2f7074203a7a30d7db4d37615541b126b5372e2d118260d4b
-  data.tar.gz: 106e2c9d67c60fa1ce5eea4ca4e27654aa416a264ed704e06cbdafc5e054b1b4
+  metadata.gz: acaae4f07bc5115a72912039e65d94e0036d7cb13eb426f5a6da08728db6e347
+  data.tar.gz: 5b52406d8576e434a23b4b7a9d30ce9ca4699e8ef16640151964067d7f799a58
 SHA512:
-  metadata.gz: 8051731609e613b09430d809b077ffcf48e3151fcc5ab5affaed09dd8da3f1a8dc7b4c39a90468e8f32599609881900abd9f5c6f4dc3f94b1f891705fd7ccd7b
-  data.tar.gz: e1b8552ede171c1ea0dc77398395c9fdaeb1b79ece9e8dabe7d61c58a94c23f44d712f91950a0adfbb8c1bafce64c4bf7aafea8312c3d2b41e53f726639030a4
+  metadata.gz: 0c6ec611ae7343d02ca09326de16c80d39d6aace82bd7eb159a9ff9e33ff038915dad79cd58760ae83fdeb613e526636cb4274ff948ec8512c96374de43a0ded
+  data.tar.gz: b7c9daffcf5364c87f529b4c7e473b50a0b88498777ed33b95e5012cac7770bf33c2d71f4f34ac0d8d5266b126fabd7f7b9613d3cdbd24767799d18dc520535e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.1
+  - Fix date syntax docs list formatting [#166](https://github.com/logstash-plugins/logstash-filter-date/pull/166)
+
 ## 3.2.0
   - Add `precision` setting to support nanosecond precision timestamps [#165](https://github.com/logstash-plugins/logstash-filter-date/pull/165)
     - `ms` (default): timestamps are stored with millisecond precision

data/docs/index.asciidoc

@@ -111,61 +111,60 @@ indicate the form of that value (2-digit month, full month name, etc).
 
 Here's what you can use to parse dates and times:
 
-[horizontal]
-y:: year
-  yyyy::: full year number. Example: `2015`.
-  yy::: two-digit year. Example: `15` for the year 2015.
+* `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.
+* `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.
+* `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.
+* `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`.
+* `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`: 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`
+* `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.
+* `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 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.*
+* `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`.
+* `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
+* `D`: day of the year
 
-e:: day of the week (number)
+* `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.
+* `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"
 

data/lib/logstash/filters/date.rb

@@ -83,58 +83,57 @@ class LogStash::Filters::Date < LogStash::Filters::Base
   #
   # Here's what you can use to parse dates and times:
   #
-  # [horizontal]
-  # 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.
-  #   SSSSSSSSS::: nanoseconds.
-  #
-  # 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.
+  # * `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.
+  # ** `SSSSSSSSS`: nanoseconds.
+  #
+  # * `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"
   #

data/logstash-filter-date.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-date'
-  s.version         = '3.2.0'
+  s.version         = '3.2.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parses dates from fields to use as the Logstash timestamp for an event"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/fixtures/old_date_filter.rb

@@ -92,57 +92,56 @@ class LogStash::Filters::DateRuby < LogStash::Filters::Base
   #
   # Here's what you can use to parse dates and times:
   #
-  # [horizontal]
-  # y:: year
-  #   yyyy::: full year number. Example: `2015`.
-  #   yy::: two-digit year. Example: `15` for the year 2015.
+  # * `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.
+  # * `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.
+  # * `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.
+  # * `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`.
+  # * `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`: 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
-  #   *Maximum precision is milliseconds (`SSS`). Beyond that, zeroes are appended.*
-  #   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::: thousandths of a second. Example:  `012` for a subsecond value `012`
+  # * `S`: fraction of a second
+  # ** Maximum precision is milliseconds (`SSS`). Beyond that, zeroes are appended.
+  # ** `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`: thousandths of a second. Example:  `012` for a subsecond value `012`
   #
-  # 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 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.*
+  # * `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`.
+  # * `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
+  # * `D`: day of the year
   #
-  # e:: day of the week (number)
+  # * `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.
+  # * `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"
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-date
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Elastic
 bindir: bin
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api