logstash-codec-multiline 3.0.9 → 3.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cd8ef67f9e950b2a7e3cdce66e5e0f312e4f3b8744945c1f37567f678e8897b9
4
- data.tar.gz: 89276e53b4cca07f377748f4788fe6673062b3769e45fdc6ff21d277d5cc8f7a
3
+ metadata.gz: 2579876a333e816be9826e4d9f0f02f67634a4e4370f90cbcde04465f9d18b2a
4
+ data.tar.gz: 4c915fe445fe7b98e3ce584432a196951317d5b8fe2be41897e0234fd25868a1
5
5
  SHA512:
6
- metadata.gz: 19f72ddf1623324f3d1e7c9d9b324c69ea76b9b92bbe993b75e044c763f242b4a673f87c93eaaf6680823ccd1327affe79d76e17c18516d2c7bbe3e8fee4a92b
7
- data.tar.gz: '049bd9fe61bbc84efa1a8e04d929d703de193426aacd8e6f008a40125c21bbfb9a3150c44fcea37225a8bbde001e73b5a2ee6d8947ab645f90d0fe539c62dcf3'
6
+ metadata.gz: 44f1bba5815ee431f52265a630628b41e5b0460a23d54fb1eccd3d21004f1fd441129434baf75616995d27ff28c2925d04510f83e36fd02d5af9e5a23dad3250
7
+ data.tar.gz: 3770b8ed35551d6c21a88f037b0ed94417b7fad630f5e680afa1bb93ca481d985d593c29af77e8537b40eb85adec5e7e2743dcf293c64aa4056a510056b573df
data/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ ## 3.1.1
2
+ - Fix: avoid reusing per-identity codec instances for differing identities. Removes a very minor optimization so that stateful codecs like CSV can work reliably [#70](https://github.com/logstash-plugins/logstash-codec-multiline/pull/70)
3
+
4
+ ## 3.1.0
5
+ - Feat: ECS compatibility [#69](https://github.com/logstash-plugins/logstash-codec-multiline/pull/69)
6
+
7
+ ## 3.0.11
8
+ - Fix: avoid long thread sleeps on codec close [#67](https://github.com/logstash-plugins/logstash-codec-multiline/pull/67)
9
+
10
+ ## 3.0.10
11
+ - Fixed [multiline codec - #32](https://github.com/logstash-plugins/logstash-codec-multiline/issues/32) `no method map_cleanup for nil class` error when shutting down.
12
+
1
13
  ## 3.0.9
2
14
  - Fixed concurrency issue causing random failures when multiline codec was used together with a multi-threaded input plugin
3
15
 
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
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.org/logstash-plugins/logstash-codec-multiline.svg)](https://travis-ci.org/logstash-plugins/logstash-codec-multiline)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-codec-multiline.svg)](https://travis-ci.com/logstash-plugins/logstash-codec-multiline)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
data/docs/index.asciidoc CHANGED
@@ -24,7 +24,7 @@ The multiline codec will collapse multiline messages and merge them into a
24
24
  single event.
25
25
 
26
26
  IMPORTANT: If you are using a Logstash input plugin that supports multiple
27
- hosts, such as the <<plugins-inputs-beats>> input plugin, you should not use
27
+ hosts, such as the {logstash-ref}/plugins-inputs-beats.html[beats input plugin], you should not use
28
28
  the multiline codec to handle multiline events. Doing so may result in the
29
29
  mixing of streams and corrupted event data. In this situation, you need to
30
30
  handle multiline events before sending the event data to Logstash.
@@ -102,13 +102,14 @@ following line.
102
102
 
103
103
 
104
104
  [id="plugins-{type}s-{plugin}-options"]
105
- ==== Multiline Codec Configuration Options
105
+ ==== Multiline codec configuration options
106
106
 
107
107
  [cols="<,<,<",options="header",]
108
108
  |=======================================================================
109
109
  |Setting |Input type|Required
110
110
  | <<plugins-{type}s-{plugin}-auto_flush_interval>> |<<number,number>>|No
111
111
  | <<plugins-{type}s-{plugin}-charset>> |<<string,string>>, one of `["ASCII-8BIT", "UTF-8", "US-ASCII", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB2312", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-31J", "Windows-1250", "Windows-1251", "Windows-1252", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "IBM037", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "EUC-JIS-2004", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "ebcdic-cp-us", "eucJP", "euc-jp-ms", "EUC-JISX0213", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "ISO8859-2", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP932", "csWindows31J", "SJIS", "PCK", "CP1250", "CP1251", "CP1252", "external", "locale"]`|No
112
+ | <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
112
113
  | <<plugins-{type}s-{plugin}-max_bytes>> |<<bytes,bytes>>|No
113
114
  | <<plugins-{type}s-{plugin}-max_lines>> |<<number,number>>|No
114
115
  | <<plugins-{type}s-{plugin}-multiline_tag>> |<<string,string>>|No
@@ -144,6 +145,19 @@ or in another character set other than `UTF-8`.
144
145
 
145
146
  This only affects "plain" format logs since JSON is `UTF-8` already.
146
147
 
148
+ [id="plugins-{type}s-{plugin}-ecs_compatibility"]
149
+ ===== `ecs_compatibility`
150
+
151
+ * Value type is <<string,string>>
152
+ * Supported values are:
153
+ ** `disabled`: plugin only sets the `message` field
154
+ ** `v1`,`v8`: Elastic Common Schema compliant behavior (`[event][original]` is also added)
155
+ * Default value depends on which version of Logstash is running:
156
+ ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
157
+ ** Otherwise, the default value is `disabled`
158
+
159
+ Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
160
+
147
161
  [id="plugins-{type}s-{plugin}-max_bytes"]
148
162
  ===== `max_bytes`
149
163
 
@@ -1,7 +1,7 @@
1
1
  # encoding: utf-8
2
2
  require "logstash/namespace"
3
- require "thread_safe"
4
- require "concurrent"
3
+ require "concurrent/atomic/atomic_boolean"
4
+ require "concurrent/map"
5
5
 
6
6
  # This class is a Codec duck type
7
7
  # Using Composition, it maps from a stream identity to
@@ -48,26 +48,35 @@ module LogStash module Codecs class IdentityMapCodec
48
48
  def start
49
49
  return self if running?
50
50
  @running.make_true
51
- @thread = Thread.new() do
51
+ @thread = Thread.start do
52
+ class_name = @listener.class.name.split('::').last # IdentityMapCodec
53
+ LogStash::Util.set_thread_name("#{class_name}##{@method_symbol}")
54
+
52
55
  while running? do
53
56
  sleep @interval
54
57
  break if !running?
55
- @listener.send(@method_symbol)
58
+ break if (listener = @listener).nil?
59
+ listener.send(@method_symbol)
56
60
  end
57
61
  end
58
62
  self
59
63
  end
60
64
 
61
65
  def running?
62
- @running.value
66
+ @running.true?
63
67
  end
64
68
 
65
69
  def stop
66
70
  return if !running?
67
71
  @running.make_false
68
- if @thread.alive?
69
- @thread.wakeup
70
- @thread.join
72
+ while @thread.alive?
73
+ begin
74
+ @thread.wakeup
75
+ rescue ThreadError
76
+ # thread might drop dead since the alive? check
77
+ else
78
+ @thread.join(0.1) # raises $! if there was any
79
+ end
71
80
  end
72
81
  @listener = nil
73
82
  end
@@ -108,7 +117,7 @@ module LogStash module Codecs class IdentityMapCodec
108
117
  def initialize(codec)
109
118
  @base_codec = codec
110
119
  @base_codecs = [codec]
111
- @identity_map = ThreadSafe::Hash.new &method(:codec_builder)
120
+ @identity_map = Concurrent::Hash.new &method(:codec_builder)
112
121
  @max_identities = MAX_IDENTITIES
113
122
  @evict_timeout = EVICT_TIMEOUT
114
123
  cleaner_interval(CLEANER_INTERVAL)
@@ -281,6 +290,7 @@ module LogStash module Codecs class IdentityMapCodec
281
290
  end
282
291
 
283
292
  def codec_without_usage_update(identity)
293
+ return base_codec if identity.nil? # mirror optimization in `stream_codec`
284
294
  find_codec_value(identity).codec
285
295
  end
286
296
 
@@ -327,7 +337,7 @@ module LogStash module Codecs class IdentityMapCodec
327
337
  end
328
338
 
329
339
  def codec_builder(hash, k)
330
- codec = hash.empty? ? @base_codec : @base_codec.clone
340
+ codec = @base_codec.clone
331
341
  codec.use_mapper_auto_flush if using_mapped_auto_flush?
332
342
  compo = CodecValue.new(codec).tap do |o|
333
343
  now = Time.now
@@ -3,6 +3,8 @@ require "logstash/codecs/base"
3
3
  require "logstash/util/charset"
4
4
  require "logstash/timestamp"
5
5
  require "logstash/codecs/auto_flush"
6
+ require 'logstash/plugin_mixins/ecs_compatibility_support'
7
+ require 'logstash/plugin_mixins/event_support/event_factory_adapter'
6
8
 
7
9
  # The multiline codec will collapse multiline messages and merge them into a
8
10
  # single event.
@@ -85,6 +87,10 @@ require "logstash/codecs/auto_flush"
85
87
  # following line.
86
88
  #
87
89
  module LogStash module Codecs class Multiline < LogStash::Codecs::Base
90
+
91
+ include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
92
+ include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
93
+
88
94
  config_name "multiline"
89
95
 
90
96
  # The regular expression to match.
@@ -141,6 +147,13 @@ module LogStash module Codecs class Multiline < LogStash::Codecs::Base
141
147
 
142
148
  public
143
149
 
150
+
151
+ def initialize(*params)
152
+ super
153
+
154
+ @original_field = ecs_select[disabled: nil, v1: '[event][original]']
155
+ end
156
+
144
157
  def register
145
158
  require "grok-pure" # rubygem 'jls-grok'
146
159
  require 'logstash/patterns/core'
@@ -197,8 +210,8 @@ module LogStash module Codecs class Multiline < LogStash::Codecs::Base
197
210
  text = @converter.convert(text)
198
211
  text.split("\n").each do |line|
199
212
  match = @grok.match(line)
200
- @logger.debug("Multiline", :pattern => @pattern, :text => line,
201
- :match => (match != false), :negate => @negate)
213
+ @logger.debug? && @logger.debug("Multiline", :text => line, :pattern => @pattern,
214
+ :match => (match != false), :negate => @negate)
202
215
 
203
216
  # Add negate option
204
217
  match = (match and !@negate) || (!match and @negate)
@@ -214,9 +227,9 @@ module LogStash module Codecs class Multiline < LogStash::Codecs::Base
214
227
  def flush(&block)
215
228
  if block_given? && @buffer.any?
216
229
  no_error = true
217
- events = merge_events
230
+ event = merge_events
218
231
  begin
219
- yield events
232
+ yield event
220
233
  rescue ::Exception => e
221
234
  # need to rescue everything
222
235
  # likliest cause: backpressure or timeout by exception
@@ -237,7 +250,9 @@ module LogStash module Codecs class Multiline < LogStash::Codecs::Base
237
250
  end
238
251
 
239
252
  def merge_events
240
- event = LogStash::Event.new(LogStash::Event::TIMESTAMP => @time, "message" => @buffer.join(NL))
253
+ message = @buffer.join(NL)
254
+ event = event_factory.new_event(LogStash::Event::TIMESTAMP => @time, "message" => message)
255
+ event.set @original_field, message.dup.freeze if @original_field
241
256
  event.tag @multiline_tag if !@multiline_tag.empty? && @buffer.size > 1
242
257
  event.tag "multiline_codec_max_bytes_reached" if over_maximum_bytes?
243
258
  event.tag "multiline_codec_max_lines_reached" if over_maximum_lines?
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-codec-multiline'
4
- s.version = '3.0.9'
4
+ s.version = '3.1.1'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Merges multiline messages into a single 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"
@@ -21,10 +21,13 @@ Gem::Specification.new do |s|
21
21
 
22
22
  # Gem dependencies
23
23
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
24
-
24
+ s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
25
+ s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0'
25
26
  s.add_runtime_dependency 'logstash-patterns-core'
26
27
  s.add_runtime_dependency 'jls-grok', '~> 0.11.1'
28
+ s.add_runtime_dependency 'concurrent-ruby'
27
29
 
28
30
  s.add_development_dependency 'logstash-devutils'
31
+ s.add_development_dependency 'insist'
29
32
  end
30
33
 
@@ -29,7 +29,8 @@ describe LogStash::Codecs::IdentityMapCodec do
29
29
  let(:stream1) { nil }
30
30
 
31
31
  it "transparently refers to the original codec" do
32
- expect(codec).to eql(codec1)
32
+ resolved_codec = demuxer.codec_without_usage_update(stream1)
33
+ expect(resolved_codec).to eq(codec)
33
34
  end
34
35
  end
35
36
 
@@ -37,8 +38,8 @@ describe LogStash::Codecs::IdentityMapCodec do
37
38
 
38
39
  before { demuxer.decode(arg1, stream1) }
39
40
 
40
- it "the first identity refers to the original codec" do
41
- expect(codec).to eql(codec1)
41
+ it "the first identity refers to a copy of original codec" do
42
+ expect(codec1).to_not eql(codec)
42
43
  end
43
44
  end
44
45
 
@@ -124,6 +125,34 @@ describe LogStash::Codecs::IdentityMapCodec do
124
125
  expect(codec2.trace_for(:close)).to be_truthy
125
126
  end
126
127
  end
128
+
129
+ context '(multiple threads)' do
130
+ let(:thread_count) { (ENV['THREAD_COUNT'] || 100).to_i }
131
+
132
+ let(:running_threads) do
133
+ thread_count.times.map do
134
+ Thread.start(described_class.new(codec)) do |codec|
135
+ codec.decode(arg1, stream1)
136
+ Thread.pass
137
+ codec.close
138
+ end
139
+ end
140
+ end
141
+
142
+ let(:stop_timeout) { 5 }
143
+
144
+ it 'does not linger around' do
145
+ running_threads.each do |thread|
146
+ next unless thread.alive?
147
+ sleep(0.5)
148
+ if thread.alive?
149
+ sleep(stop_timeout)
150
+ fail "codec did not stop in #{stop_timeout}s" if thread.alive?
151
+ end
152
+ end
153
+ end
154
+
155
+ end
127
156
  end
128
157
 
129
158
  describe "over capacity protection" do
@@ -184,8 +213,11 @@ describe LogStash::Codecs::IdentityMapCodec do
184
213
  let(:demuxer) { described_class.new(codec).evict_timeout(1).cleaner_interval(1) }
185
214
  it "the cleaner evicts the codec and flushes it first" do
186
215
  demuxer.decode(Object.new, "stream1"){|*| 42}
216
+ mapped_codec = demuxer.codec_without_usage_update("stream1") # get before eviction
217
+
187
218
  sleep(2.1)
188
- expect(codec.trace_for(:flush)).to eq(42)
219
+
220
+ expect(mapped_codec.trace_for(:flush)).to eq(42)
189
221
  expect(demuxer.identity_map.keys).not_to include("stream1")
190
222
  end
191
223
  end
@@ -199,9 +231,12 @@ describe LogStash::Codecs::IdentityMapCodec do
199
231
  end
200
232
  it "the cleaner evicts the codec and flushes it first using the eviction_block" do
201
233
  demuxer.decode(Object.new, "stream1"){|*| 42}
234
+ mapped_codec = demuxer.codec_without_usage_update("stream1") # get before eviction
235
+
202
236
  sleep(2.1)
203
- expect(codec.trace_for(:flush)).to eq(24)
204
- expect(demuxer.identity_map.keys).not_to include("stream1")
237
+
238
+ expect(mapped_codec.trace_for(:flush)).to eq(24)
239
+ expect(demuxer.identity_map.keys).to_not include("stream1")
205
240
  end
206
241
  end
207
242
  end
@@ -223,7 +258,9 @@ describe LogStash::Codecs::IdentityMapCodec do
223
258
  it "no events are generated (the line is buffered)" do
224
259
  expect(imc.identity_count).to eq(1)
225
260
  expect(queue.size).to eq(0)
226
- expect(mlc.internal_buffer[0]).to eq("foo")
261
+
262
+ mapped_codec = imc.codec_without_usage_update(identity)
263
+ expect(mapped_codec.internal_buffer[0]).to eq("foo")
227
264
  end
228
265
  end
229
266
 
@@ -7,8 +7,9 @@ require_relative "../supports/helpers.rb"
7
7
  # above helper also defines a subclass of Multiline
8
8
  # called MultilineRspec that exposes the internal buffer
9
9
  # and a Logger Mock
10
+ require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
10
11
 
11
- describe LogStash::Codecs::Multiline do
12
+ describe LogStash::Codecs::Multiline, :ecs_compatibility_support do
12
13
  context "#decode" do
13
14
  let(:config) { {} }
14
15
  let(:codec) { LogStash::Codecs::Multiline.new(config).tap {|c| c.register } }
@@ -23,17 +24,35 @@ describe LogStash::Codecs::Multiline do
23
24
  end
24
25
  end
25
26
 
26
- it "should be able to handle multiline events with additional lines space-indented" do
27
- config.update("pattern" => "^\\s", "what" => "previous")
28
- lines = [ "hello world", " second line", "another first line" ]
29
- line_producer.call(lines)
30
- codec.flush { |e| events << e }
27
+ ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
28
+
29
+ before(:each) do
30
+ allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
31
+ end
32
+
33
+ let(:config) { super().merge "pattern" => "^\\s", "what" => "previous" }
34
+ let(:lines) { [ "hello world", " second line", "another first line" ] }
35
+
36
+ let(:expected_first_multiline) { "hello world\n second line" }
37
+
38
+ before do
39
+ line_producer.call(lines)
40
+ codec.flush { |e| events << e }
41
+ end
42
+
43
+ it "should be able to handle multiline events with additional lines space-indented" do
44
+ expect(events.size).to eq(2)
45
+ expect(events[0].get("message")).to eql expected_first_multiline
46
+ expect(events[0].get("tags")).to include("multiline")
47
+ expect(events[1].get("message")).to eql "another first line"
48
+ expect(events[1].get("tags")).to be_nil
49
+ end
50
+
51
+ it "sets event.original in ECS mode" do
52
+ expect(events.size).to eq(2)
53
+ expect(events[0].get("[event][original]")).to eql expected_first_multiline
54
+ end if ecs_select.active_mode != :disabled
31
55
 
32
- expect(events.size).to eq(2)
33
- expect(events[0].get("message")).to eq "hello world\n second line"
34
- expect(events[0].get("tags")).to include("multiline")
35
- expect(events[1].get("message")).to eq "another first line"
36
- expect(events[1].get("tags")).to be_nil
37
56
  end
38
57
 
39
58
  it "should allow custom tag added to multiline events" do
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-codec-multiline
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.9
4
+ version: 3.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-01-17 00:00:00.000000000 Z
11
+ date: 2021-09-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -30,6 +30,34 @@ dependencies:
30
30
  - - "<="
31
31
  - !ruby/object:Gem::Version
32
32
  version: '2.99'
33
+ - !ruby/object:Gem::Dependency
34
+ requirement: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - "~>"
37
+ - !ruby/object:Gem::Version
38
+ version: '1.3'
39
+ name: logstash-mixin-ecs_compatibility_support
40
+ prerelease: false
41
+ type: :runtime
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.3'
47
+ - !ruby/object:Gem::Dependency
48
+ requirement: !ruby/object:Gem::Requirement
49
+ requirements:
50
+ - - "~>"
51
+ - !ruby/object:Gem::Version
52
+ version: '1.0'
53
+ name: logstash-mixin-event_support
54
+ prerelease: false
55
+ type: :runtime
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '1.0'
33
61
  - !ruby/object:Gem::Dependency
34
62
  requirement: !ruby/object:Gem::Requirement
35
63
  requirements:
@@ -58,6 +86,20 @@ dependencies:
58
86
  - - "~>"
59
87
  - !ruby/object:Gem::Version
60
88
  version: 0.11.1
89
+ - !ruby/object:Gem::Dependency
90
+ requirement: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ name: concurrent-ruby
96
+ prerelease: false
97
+ type: :runtime
98
+ version_requirements: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
61
103
  - !ruby/object:Gem::Dependency
62
104
  requirement: !ruby/object:Gem::Requirement
63
105
  requirements:
@@ -72,6 +114,20 @@ dependencies:
72
114
  - - ">="
73
115
  - !ruby/object:Gem::Version
74
116
  version: '0'
117
+ - !ruby/object:Gem::Dependency
118
+ requirement: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ name: insist
124
+ prerelease: false
125
+ type: :development
126
+ version_requirements: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: '0'
75
131
  description: This gem is a Logstash plugin required to be installed on top of the
76
132
  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
77
133
  gem is not a stand-alone program
@@ -117,8 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
117
173
  - !ruby/object:Gem::Version
118
174
  version: '0'
119
175
  requirements: []
120
- rubyforge_project:
121
- rubygems_version: 2.6.13
176
+ rubygems_version: 3.1.6
122
177
  signing_key:
123
178
  specification_version: 4
124
179
  summary: Merges multiline messages into a single event