logstash-filter-date 3.1.5 → 3.1.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +19 -1
- data/CONTRIBUTORS +1 -0
- data/Gemfile +8 -1
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +215 -0
- data/lib/logstash-filter-date_jars.rb +1 -1
- data/logstash-filter-date.gemspec +5 -4
- data/spec/filters/date_spec.rb +70 -17
- data/vendor/jar-dependencies/org/logstash/filters/logstash-filter-date/3.1.6/logstash-filter-date-3.1.6.jar +0 -0
- metadata +24 -8
- data/vendor/jar-dependencies/org/logstash/filters/logstash-filter-date/3.1.0/logstash-filter-date-3.1.0.jar +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 31ec569a82c028d4cfe9e52115362fe5e9a62003a027e9353eadfe3cfd4b7849
|
4
|
+
data.tar.gz: b1502448af6b5021b3c36f698a8f1d72c001c1648d52b67bfbc5f38dbd555ca8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 110d7d64870d88e88392a09cabb58ce7b210da31e603030b7527207157289e0f99b549900e38d6d1f3ecf4c6242ad226d1fde11023595e63677b26b9758d43f2
|
7
|
+
data.tar.gz: 33d314cacf14063e6764a26908ca6a67766e233e93aad520dd18a8a55ca8db83e8ee5632a5293baa90bf50a13e6b31b3820fdeb81e24477ef49b9383e9b0e82d
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,21 @@
|
|
1
|
+
## 3.1.11
|
2
|
+
- Internal: upgrade packaging tooling to Gradle 7 so that plugin can be packaged on modern Java releases [#140](https://github.com/logstash-plugins/logstash-filter-date/pull/140)
|
3
|
+
- Internal: refined spec and unit test assertions to account for changes in how timestamps are serialised in Logstash 8. [#141](https://github.com/logstash-plugins/logstash-filter-date/pull/141)
|
4
|
+
- Update log4j dependencies [#142](https://github.com/logstash-plugins/logstash-filter-date/pull/142)
|
5
|
+
## 3.1.10
|
6
|
+
- Build against JRuby 9k #116
|
7
|
+
- Fix build failure #114
|
8
|
+
|
9
|
+
## 3.1.9
|
10
|
+
- Update gemspec summary
|
11
|
+
|
12
|
+
## 3.1.8
|
13
|
+
- Fix some documentation issues
|
14
|
+
|
15
|
+
## 3.1.6
|
16
|
+
- Fix #97 With "ISO8601" format and timezone interpolation, Joda complains at plugin startup
|
17
|
+
- Fix skipped DST test, caused by incorrect year guess logic, see comment in test spec/filters/date_spec.rb:540
|
18
|
+
|
1
19
|
## 3.1.5
|
2
20
|
- Ignore cancelled events
|
3
21
|
|
@@ -49,7 +67,7 @@
|
|
49
67
|
- use Event#tag, relax specs for Java Event, code cleanups
|
50
68
|
|
51
69
|
## 2.0.0
|
52
|
-
- Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
|
70
|
+
- Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
|
53
71
|
instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
|
54
72
|
- Dependency on logstash-core update to 2.0
|
55
73
|
|
data/CONTRIBUTORS
CHANGED
@@ -25,6 +25,7 @@ Contributors:
|
|
25
25
|
* Richard Pijnenburg (electrical)
|
26
26
|
* Suyog Rao (suyograo)
|
27
27
|
* debadair
|
28
|
+
* Guy Boertje (guyboertje)
|
28
29
|
|
29
30
|
Note: If you've sent us patches, bug reports, or otherwise contributed to
|
30
31
|
Logstash, and you aren't on the list above and want to be, please let us know
|
data/Gemfile
CHANGED
@@ -1,4 +1,11 @@
|
|
1
1
|
source 'https://rubygems.org'
|
2
2
|
|
3
|
-
# Specify your gem's dependencies in logstash-mass_effect.gemspec
|
4
3
|
gemspec
|
4
|
+
|
5
|
+
logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
|
6
|
+
use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
|
7
|
+
|
8
|
+
if Dir.exist?(logstash_path) && use_logstash_source
|
9
|
+
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
|
+
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
|
+
end
|
data/LICENSE
CHANGED
@@ -1,13 +1,202 @@
|
|
1
|
-
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
|
2
1
|
|
3
|
-
|
4
|
-
|
5
|
-
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
6
5
|
|
7
|
-
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
7
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright 2020 Elastic and contributors
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Logstash Plugin
|
2
2
|
|
3
|
-
[![Travis Build Status](https://travis-ci.
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-date.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-date)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
data/docs/index.asciidoc
ADDED
@@ -0,0 +1,215 @@
|
|
1
|
+
:plugin: date
|
2
|
+
:type: filter
|
3
|
+
|
4
|
+
///////////////////////////////////////////
|
5
|
+
START - GENERATED VARIABLES, DO NOT EDIT!
|
6
|
+
///////////////////////////////////////////
|
7
|
+
:version: %VERSION%
|
8
|
+
:release_date: %RELEASE_DATE%
|
9
|
+
:changelog_url: %CHANGELOG_URL%
|
10
|
+
:include_path: ../../../../logstash/docs/include
|
11
|
+
///////////////////////////////////////////
|
12
|
+
END - GENERATED VARIABLES, DO NOT EDIT!
|
13
|
+
///////////////////////////////////////////
|
14
|
+
|
15
|
+
[id="plugins-{type}s-{plugin}"]
|
16
|
+
|
17
|
+
=== Date filter plugin
|
18
|
+
|
19
|
+
include::{include_path}/plugin_header.asciidoc[]
|
20
|
+
|
21
|
+
==== Description
|
22
|
+
|
23
|
+
The date filter is used for parsing dates from fields, and then using that
|
24
|
+
date or timestamp as the logstash timestamp for the event.
|
25
|
+
|
26
|
+
For example, syslog events usually have timestamps like this:
|
27
|
+
[source,ruby]
|
28
|
+
"Apr 17 09:32:01"
|
29
|
+
|
30
|
+
You would use the date format `MMM dd HH:mm:ss` to parse this.
|
31
|
+
|
32
|
+
The date filter is especially important for sorting events and for
|
33
|
+
backfilling old data. If you don't get the date correct in your
|
34
|
+
event, then searching for them later will likely sort out of order.
|
35
|
+
|
36
|
+
In the absence of this filter, logstash will choose a timestamp based on the
|
37
|
+
first time it sees the event (at input time), if the timestamp is not already
|
38
|
+
set in the event. For example, with file input, the timestamp is set to the
|
39
|
+
time of each read.
|
40
|
+
|
41
|
+
[id="plugins-{type}s-{plugin}-options"]
|
42
|
+
==== Date Filter Configuration Options
|
43
|
+
|
44
|
+
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
|
45
|
+
|
46
|
+
[cols="<,<,<",options="header",]
|
47
|
+
|=======================================================================
|
48
|
+
|Setting |Input type|Required
|
49
|
+
| <<plugins-{type}s-{plugin}-locale>> |<<string,string>>|No
|
50
|
+
| <<plugins-{type}s-{plugin}-match>> |<<array,array>>|No
|
51
|
+
| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<array,array>>|No
|
52
|
+
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|
53
|
+
| <<plugins-{type}s-{plugin}-timezone>> |<<string,string>>|No
|
54
|
+
|=======================================================================
|
55
|
+
|
56
|
+
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
57
|
+
filter plugins.
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
[id="plugins-{type}s-{plugin}-locale"]
|
62
|
+
===== `locale`
|
63
|
+
|
64
|
+
* Value type is <<string,string>>
|
65
|
+
* There is no default value for this setting.
|
66
|
+
|
67
|
+
Specify a locale to be used for date parsing using either IETF-BCP47 or POSIX language tag.
|
68
|
+
Simple examples are `en`,`en-US` for BCP47 or `en_US` for POSIX.
|
69
|
+
|
70
|
+
The locale is mostly necessary to be set for parsing month names (pattern with `MMM`) and
|
71
|
+
weekday names (pattern with `EEE`).
|
72
|
+
|
73
|
+
If not specified, the platform default will be used but for non-english platform default
|
74
|
+
an english parser will also be used as a fallback mechanism.
|
75
|
+
|
76
|
+
[id="plugins-{type}s-{plugin}-match"]
|
77
|
+
===== `match`
|
78
|
+
|
79
|
+
* Value type is <<array,array>>
|
80
|
+
* Default value is `[]`
|
81
|
+
|
82
|
+
An array with field name first, and format patterns following, `[ field,
|
83
|
+
formats... ]`
|
84
|
+
|
85
|
+
If your time field has multiple possible formats, you can do this:
|
86
|
+
[source,ruby]
|
87
|
+
match => [ "logdate", "MMM dd yyyy HH:mm:ss",
|
88
|
+
"MMM d yyyy HH:mm:ss", "ISO8601" ]
|
89
|
+
|
90
|
+
The above will match a syslog (rfc3164) or `iso8601` timestamp.
|
91
|
+
|
92
|
+
There are a few special exceptions. The following format literals exist
|
93
|
+
to help you save time and ensure correctness of date parsing.
|
94
|
+
|
95
|
+
* `ISO8601` - should parse any valid ISO8601 timestamp, such as
|
96
|
+
`2011-04-19T03:44:01.103Z`
|
97
|
+
* `UNIX` - will parse *float or int* value expressing unix time in seconds since epoch like 1326149001.132 as well as 1326149001
|
98
|
+
* `UNIX_MS` - will parse **int** value expressing unix time in milliseconds since epoch like 1366125117000
|
99
|
+
* `TAI64N` - will parse tai64n time values
|
100
|
+
|
101
|
+
For example, if you have a field `logdate`, with a value that looks like
|
102
|
+
`Aug 13 2010 00:03:44`, you would use this configuration:
|
103
|
+
[source,ruby]
|
104
|
+
filter {
|
105
|
+
date {
|
106
|
+
match => [ "logdate", "MMM dd yyyy HH:mm:ss" ]
|
107
|
+
}
|
108
|
+
}
|
109
|
+
|
110
|
+
If your field is nested in your structure, you can use the nested
|
111
|
+
syntax `[foo][bar]` to match its value. For more information, please refer to
|
112
|
+
<<logstash-config-field-references>>
|
113
|
+
|
114
|
+
*More details on the syntax*
|
115
|
+
|
116
|
+
The syntax used for parsing date and time text uses letters to indicate the
|
117
|
+
kind of time value (month, minute, etc), and a repetition of letters to
|
118
|
+
indicate the form of that value (2-digit month, full month name, etc).
|
119
|
+
|
120
|
+
Here's what you can use to parse dates and times:
|
121
|
+
|
122
|
+
[horizontal]
|
123
|
+
y:: year
|
124
|
+
yyyy::: full year number. Example: `2015`.
|
125
|
+
yy::: two-digit year. Example: `15` for the year 2015.
|
126
|
+
|
127
|
+
M:: month of the year
|
128
|
+
M::: minimal-digit month. Example: `1` for January and `12` for December.
|
129
|
+
MM::: two-digit month. zero-padded if needed. Example: `01` for January and `12` for December
|
130
|
+
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.
|
131
|
+
MMMM::: full month text, Example: `January`. Note: The language used depends on your locale.
|
132
|
+
|
133
|
+
d:: day of the month
|
134
|
+
d::: minimal-digit day. Example: `1` for the 1st of the month.
|
135
|
+
dd::: two-digit day, zero-padded if needed. Example: `01` for the 1st of the month.
|
136
|
+
|
137
|
+
H:: hour of the day (24-hour clock)
|
138
|
+
H::: minimal-digit hour. Example: `0` for midnight.
|
139
|
+
HH::: two-digit hour, zero-padded if needed. Example: `00` for midnight.
|
140
|
+
|
141
|
+
m:: minutes of the hour (60 minutes per hour)
|
142
|
+
m::: minimal-digit minutes. Example: `0`.
|
143
|
+
mm::: two-digit minutes, zero-padded if needed. Example: `00`.
|
144
|
+
|
145
|
+
s:: seconds of the minute (60 seconds per minute)
|
146
|
+
s::: minimal-digit seconds. Example: `0`.
|
147
|
+
ss::: two-digit seconds, zero-padded if needed. Example: `00`.
|
148
|
+
|
149
|
+
S:: fraction of a second
|
150
|
+
*Maximum precision is milliseconds (`SSS`). Beyond that, zeroes are appended.*
|
151
|
+
S::: tenths of a second. Example: `0` for a subsecond value `012`
|
152
|
+
SS::: hundredths of a second. Example: `01` for a subsecond value `01`
|
153
|
+
SSS::: thousandths of a second. Example: `012` for a subsecond value `012`
|
154
|
+
|
155
|
+
Z:: time zone offset or identity
|
156
|
+
Z::: Timezone offset structured as HHmm (hour and minutes offset from Zulu/UTC). Example: `-0700`.
|
157
|
+
ZZ::: Timezone offset structured as HH:mm (colon in between hour and minute offsets). Example: `-07:00`.
|
158
|
+
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].
|
159
|
+
|
160
|
+
z:: time zone names. *Time zone names ('z') cannot be parsed.*
|
161
|
+
|
162
|
+
w:: week of the year
|
163
|
+
w::: minimal-digit week. Example: `1`.
|
164
|
+
ww::: two-digit week, zero-padded if needed. Example: `01`.
|
165
|
+
|
166
|
+
D:: day of the year
|
167
|
+
|
168
|
+
e:: day of the week (number)
|
169
|
+
|
170
|
+
E:: day of the week (text)
|
171
|
+
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.
|
172
|
+
EEEE::: The full text day of the week. Example: `Monday`, `Tuesday`, ... Note: The actual language of this will depend on your locale.
|
173
|
+
|
174
|
+
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"
|
175
|
+
|
176
|
+
Other less common date units, such as era (G), century \(C), am/pm (a), and # more, can be learned about on the
|
177
|
+
http://www.joda.org/joda-time/key_format.html[joda-time documentation].
|
178
|
+
|
179
|
+
[id="plugins-{type}s-{plugin}-tag_on_failure"]
|
180
|
+
===== `tag_on_failure`
|
181
|
+
|
182
|
+
* Value type is <<array,array>>
|
183
|
+
* Default value is `["_dateparsefailure"]`
|
184
|
+
|
185
|
+
Append values to the `tags` field when there has been no
|
186
|
+
successful match
|
187
|
+
|
188
|
+
[id="plugins-{type}s-{plugin}-target"]
|
189
|
+
===== `target`
|
190
|
+
|
191
|
+
* Value type is <<string,string>>
|
192
|
+
* Default value is `"@timestamp"`
|
193
|
+
|
194
|
+
Store the matching timestamp into the given target field. If not provided,
|
195
|
+
default to updating the `@timestamp` field of the event.
|
196
|
+
|
197
|
+
[id="plugins-{type}s-{plugin}-timezone"]
|
198
|
+
===== `timezone`
|
199
|
+
|
200
|
+
* Value type is <<string,string>>
|
201
|
+
* There is no default value for this setting.
|
202
|
+
|
203
|
+
Specify a time zone canonical ID to be used for date parsing.
|
204
|
+
The valid IDs are listed on the http://joda-time.sourceforge.net/timezones.html[Joda.org available time zones page].
|
205
|
+
This is useful in case the time zone cannot be extracted from the value,
|
206
|
+
and is not the platform default.
|
207
|
+
If this is not specified the platform default will be used.
|
208
|
+
Canonical ID is good as it takes care of daylight saving time for you
|
209
|
+
For example, `America/Los_Angeles` or `Europe/Paris` are valid IDs.
|
210
|
+
This field can be dynamic and include parts of the event using the `%{field}` syntax
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
[id="plugins-{type}s-{plugin}-common-options"]
|
215
|
+
include::{include_path}/{type}.asciidoc[]
|
@@ -1,9 +1,9 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-filter-date'
|
4
|
-
s.version = '3.1.
|
4
|
+
s.version = '3.1.11'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
|
-
s.summary = "
|
6
|
+
s.summary = "Parses dates from fields to use as the Logstash timestamp for an event"
|
7
7
|
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"
|
8
8
|
s.authors = ["Elastic"]
|
9
9
|
s.email = 'info@elastic.co'
|
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
|
|
11
11
|
s.require_paths = ["lib", "vendor/jar-dependencies"]
|
12
12
|
|
13
13
|
# Files
|
14
|
-
s.files = Dir[
|
14
|
+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
15
15
|
|
16
16
|
# Tests
|
17
17
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
|
|
24
24
|
s.add_development_dependency 'logstash-input-generator'
|
25
25
|
s.add_development_dependency 'logstash-codec-json'
|
26
26
|
s.add_development_dependency 'logstash-output-null'
|
27
|
-
s.add_development_dependency 'logstash-devutils'
|
27
|
+
s.add_development_dependency 'logstash-devutils', '>= 2.3'
|
28
|
+
s.add_development_dependency 'insist'
|
28
29
|
s.add_development_dependency 'benchmark-ips'
|
29
30
|
end
|
30
31
|
|
data/spec/filters/date_spec.rb
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
|
3
3
|
require "logstash/devutils/rspec/spec_helper"
|
4
|
+
require "insist"
|
4
5
|
require "logstash/filters/date"
|
5
6
|
|
6
7
|
puts "Skipping date performance tests because this ruby is not jruby" if RUBY_ENGINE != "jruby"
|
@@ -127,7 +128,7 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
127
128
|
#Invalid value should not be evaluated to zero (String#to_i madness)
|
128
129
|
sample("mydate" => "%{bad_value}") do
|
129
130
|
insist { subject.get("mydate") } == "%{bad_value}"
|
130
|
-
insist { subject.get("@timestamp") } != Time.iso8601("1970-01-01T00:00:00.000Z").utc
|
131
|
+
insist { subject.get("@timestamp").time } != Time.iso8601("1970-01-01T00:00:00.000Z").utc
|
131
132
|
end
|
132
133
|
end
|
133
134
|
|
@@ -155,15 +156,16 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
155
156
|
#Invalid value should not be evaluated to zero (String#to_i madness)
|
156
157
|
sample("mydate" => "%{bad_value}") do
|
157
158
|
insist { subject.get("mydate") } == "%{bad_value}"
|
158
|
-
insist { subject.get("@timestamp") } != Time.iso8601("1970-01-01T00:00:00.000Z").utc
|
159
|
+
insist { subject.get("@timestamp").time } != Time.iso8601("1970-01-01T00:00:00.000Z").utc
|
159
160
|
end
|
160
161
|
|
161
162
|
# Regression test
|
162
|
-
# Support numeric values that come through the JSON parser. These numbers appear as BigDecimal
|
163
|
+
# Support numeric values that come through the JSON parser. These numbers appear as BigDecimal
|
163
164
|
# instead of Float.
|
164
165
|
sample(LogStash::Json.load('{ "mydate": 1350414944.123456 }')) do
|
165
|
-
|
166
|
-
|
166
|
+
# its generally problematic to compare different Floating Point class implementations using equals
|
167
|
+
# because they can't always represent a value exactly.
|
168
|
+
insist { subject.get("mydate") } == BigDecimal.new("1350414944.123456")
|
167
169
|
insist { subject.get("@timestamp").time } == Time.iso8601("2012-10-16T12:15:44.123-07:00").utc
|
168
170
|
end
|
169
171
|
end
|
@@ -191,7 +193,7 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
191
193
|
times.each do |input, output|
|
192
194
|
sample("mydate" => input) do
|
193
195
|
insist { subject.get("mydate") } == input
|
194
|
-
insist { subject.get("@timestamp").time } == Time.iso8601(output)
|
196
|
+
insist { subject.get("@timestamp").time } == Time.iso8601(output).utc
|
195
197
|
end
|
196
198
|
end # times.each
|
197
199
|
end
|
@@ -223,7 +225,7 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
223
225
|
times.each do |input, output|
|
224
226
|
sample("mydate" => input) do
|
225
227
|
insist { subject.get("mydate") } == input
|
226
|
-
insist { subject.get("@timestamp").time } == Time.iso8601(output)
|
228
|
+
insist { subject.get("@timestamp").time } == Time.iso8601(output).utc
|
227
229
|
end
|
228
230
|
end # times.each
|
229
231
|
end
|
@@ -323,7 +325,8 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
323
325
|
CONFIG
|
324
326
|
|
325
327
|
sample("thedate" => "2013/Apr/21") do
|
326
|
-
|
328
|
+
expected = Time.iso8601("2013-04-21T00:00:00.000Z").utc
|
329
|
+
expect(subject.get("@timestamp").time).not_to eq(expected)
|
327
330
|
end
|
328
331
|
end
|
329
332
|
|
@@ -333,12 +336,14 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
333
336
|
date {
|
334
337
|
match => [ "thedate", "yyyy/MM/dd" ]
|
335
338
|
add_tag => "tagged"
|
339
|
+
timezone => "UTC"
|
336
340
|
}
|
337
341
|
}
|
338
342
|
CONFIG
|
339
343
|
|
340
344
|
sample("thedate" => "2013/04/21") do
|
341
|
-
|
345
|
+
expected = Time.iso8601("2013-04-21T00:00:00.000Z").utc
|
346
|
+
expect(subject.get("@timestamp").time).to eq(expected)
|
342
347
|
insist { subject.get("tags") } == ["tagged"]
|
343
348
|
end
|
344
349
|
end
|
@@ -349,12 +354,14 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
349
354
|
date {
|
350
355
|
match => [ "thedate", "yyyy/MM/dd" ]
|
351
356
|
add_tag => "tagged"
|
357
|
+
timezone => "UTC"
|
352
358
|
}
|
353
359
|
}
|
354
360
|
CONFIG
|
355
361
|
|
356
362
|
sample("thedate" => "2013/Apr/21") do
|
357
|
-
|
363
|
+
expected = Time.iso8601("2013-04-21T00:00:00.000Z").utc
|
364
|
+
expect(subject.get("@timestamp").time).not_to eq(expected)
|
358
365
|
reject { subject.get("tags") }.include? "tagged"
|
359
366
|
end
|
360
367
|
end
|
@@ -365,12 +372,14 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
365
372
|
date {
|
366
373
|
match => [ "thedate", "yyyy/MM/dd" ]
|
367
374
|
tag_on_failure => ["date_failed"]
|
375
|
+
timezone => "UTC"
|
368
376
|
}
|
369
377
|
}
|
370
378
|
CONFIG
|
371
379
|
|
372
380
|
sample("thedate" => "2013/Apr/21") do
|
373
|
-
|
381
|
+
expected = Time.iso8601("2013-04-21T00:00:00.000Z").utc
|
382
|
+
expect(subject.get("@timestamp").time).not_to eq(expected)
|
374
383
|
insist { subject.get("tags") }.include? "date_failed"
|
375
384
|
end
|
376
385
|
end
|
@@ -423,6 +432,35 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
423
432
|
end # times.each
|
424
433
|
end
|
425
434
|
|
435
|
+
describe "parsing IS08601 with timezone from event" do
|
436
|
+
config <<-CONFIG
|
437
|
+
filter {
|
438
|
+
date {
|
439
|
+
match => ["mydate", "ISO8601"]
|
440
|
+
locale => "en"
|
441
|
+
timezone => "%{mytz}"
|
442
|
+
}
|
443
|
+
}
|
444
|
+
CONFIG
|
445
|
+
|
446
|
+
require 'java'
|
447
|
+
|
448
|
+
# Venezuela changed from -4:00 to -4:30 at 03:00 on Sun, 9 Dec 2007
|
449
|
+
sample("mydate" => "2007-12-09T01:00:00", "mytz" => "America/Caracas") do
|
450
|
+
expect(subject.get("mydate")).to eq("2007-12-09T01:00:00")
|
451
|
+
expect(subject.get("@timestamp").time).to eq(Time.iso8601("2007-12-09T05:00:00.000Z").utc)
|
452
|
+
end
|
453
|
+
sample("mydate" => "2007-12-09T10:00:00", "mytz" => "America/Caracas") do
|
454
|
+
expect(subject.get("mydate")).to eq("2007-12-09T10:00:00")
|
455
|
+
expect(subject.get("@timestamp").time).to eq(Time.iso8601("2007-12-09T14:30:00.000Z").utc)
|
456
|
+
end
|
457
|
+
# Venezuela changed from -4:30 to -4:00 at 02:30 on Sunday, 1 May 2016
|
458
|
+
sample("mydate" => "2016-05-01T08:18:18.123", "mytz" => "America/Caracas") do
|
459
|
+
expect(subject.get("mydate")).to eq("2016-05-01T08:18:18.123")
|
460
|
+
expect(subject.get("@timestamp").time).to eq(Time.iso8601("2016-05-01T12:18:18.123Z").utc)
|
461
|
+
end
|
462
|
+
end
|
463
|
+
|
426
464
|
describe "don't fail on next years DST switchover in CET" do
|
427
465
|
config <<-CONFIG
|
428
466
|
filter {
|
@@ -440,9 +478,8 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
440
478
|
end
|
441
479
|
|
442
480
|
sample "2016 Mar 26 02:00:37" do
|
443
|
-
p :subject => subject
|
444
481
|
insist { subject.get("tags") } != ["_dateparsefailure"]
|
445
|
-
|
482
|
+
expect(subject.get("@timestamp")).to be_a_logstash_timestamp_equivalent_to("2016-03-26T01:00:37.000Z")
|
446
483
|
end
|
447
484
|
end
|
448
485
|
|
@@ -508,7 +545,14 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
508
545
|
end
|
509
546
|
end
|
510
547
|
|
511
|
-
describe "
|
548
|
+
describe "do fail on 2016 DST switchover in CET" do
|
549
|
+
# This test tries to parse a time that doesn't exist. '02:00:01' is a time that doesn't exist
|
550
|
+
# because this DST switch goes from 01:59:59 to 03:00:00, skipping 2am entirely. The last Sunday of March in 2016 was 27th.
|
551
|
+
# (Guy Boertje) Fixed the GuessYear logic
|
552
|
+
# Joda has a default year for DateTimeFormat of 2000
|
553
|
+
# meaning that the initial time parsed was Monday 2000-03-27 02:00:01 and the last Sunday of March in 2000 was the 26th
|
554
|
+
# then by adding the year of 2016 creates an invalid time
|
555
|
+
# The parser default now takes the year from the DefaultClock in the JodaParser
|
512
556
|
config <<-CONFIG
|
513
557
|
filter {
|
514
558
|
date {
|
@@ -525,9 +569,18 @@ RUBY_ENGINE == "jruby" and describe LogStash::Filters::Date do
|
|
525
569
|
org.logstash.filters.parser.JodaParser.setDefaultClock { org.joda.time.DateTime.new(2016,03,29,23,59,50, org.joda.time.DateTimeZone::UTC ) }
|
526
570
|
end
|
527
571
|
|
528
|
-
sample "Mar
|
529
|
-
|
530
|
-
|
572
|
+
sample "Mar 27 01:59:59" do
|
573
|
+
expect(subject.get("tags")).to be_nil
|
574
|
+
expect(subject.get("@timestamp")).to be_a_logstash_timestamp_equivalent_to("2016-03-27T00:59:59.000Z")
|
575
|
+
end
|
576
|
+
|
577
|
+
sample "Mar 27 02:00:01" do
|
578
|
+
expect(subject.get("tags")).to eq ["_dateparsefailure"]
|
579
|
+
end
|
580
|
+
|
581
|
+
sample "Mar 27 03:00:01" do
|
582
|
+
expect(subject.get("tags")).to be_nil
|
583
|
+
expect(subject.get("@timestamp")).to be_a_logstash_timestamp_equivalent_to("2016-03-27T01:00:01.000Z")
|
531
584
|
end
|
532
585
|
end
|
533
586
|
end
|
Binary file
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-filter-date
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.1.
|
4
|
+
version: 3.1.11
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Elastic
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -77,10 +77,24 @@ dependencies:
|
|
77
77
|
requirements:
|
78
78
|
- - ">="
|
79
79
|
- !ruby/object:Gem::Version
|
80
|
-
version: '
|
80
|
+
version: '2.3'
|
81
81
|
name: logstash-devutils
|
82
82
|
prerelease: false
|
83
83
|
type: :development
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - ">="
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '2.3'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
requirement: !ruby/object:Gem::Requirement
|
91
|
+
requirements:
|
92
|
+
- - ">="
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: '0'
|
95
|
+
name: insist
|
96
|
+
prerelease: false
|
97
|
+
type: :development
|
84
98
|
version_requirements: !ruby/object:Gem::Requirement
|
85
99
|
requirements:
|
86
100
|
- - ">="
|
@@ -100,7 +114,9 @@ dependencies:
|
|
100
114
|
- - ">="
|
101
115
|
- !ruby/object:Gem::Version
|
102
116
|
version: '0'
|
103
|
-
description: This gem is a Logstash plugin required to be installed on top of the
|
117
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
118
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
119
|
+
gem is not a stand-alone program
|
104
120
|
email: info@elastic.co
|
105
121
|
executables: []
|
106
122
|
extensions: []
|
@@ -112,12 +128,13 @@ files:
|
|
112
128
|
- LICENSE
|
113
129
|
- NOTICE.TXT
|
114
130
|
- README.md
|
131
|
+
- docs/index.asciidoc
|
115
132
|
- lib/logstash-filter-date_jars.rb
|
116
133
|
- lib/logstash/filters/date.rb
|
117
134
|
- logstash-filter-date.gemspec
|
118
135
|
- spec/filters/date_spec.rb
|
119
136
|
- spec/fixtures/old_date_filter.rb
|
120
|
-
- vendor/jar-dependencies/org/logstash/filters/logstash-filter-date/3.1.
|
137
|
+
- vendor/jar-dependencies/org/logstash/filters/logstash-filter-date/3.1.6/logstash-filter-date-3.1.6.jar
|
121
138
|
homepage: http://www.elastic.co/guide/en/logstash/current/index.html
|
122
139
|
licenses:
|
123
140
|
- Apache License (2.0)
|
@@ -140,11 +157,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
140
157
|
- !ruby/object:Gem::Version
|
141
158
|
version: '0'
|
142
159
|
requirements: []
|
143
|
-
|
144
|
-
rubygems_version: 2.4.8
|
160
|
+
rubygems_version: 3.1.6
|
145
161
|
signing_key:
|
146
162
|
specification_version: 4
|
147
|
-
summary:
|
163
|
+
summary: Parses dates from fields to use as the Logstash timestamp for an event
|
148
164
|
test_files:
|
149
165
|
- spec/filters/date_spec.rb
|
150
166
|
- spec/fixtures/old_date_filter.rb
|