logstash-output-file 4.2.6 → 4.3.0

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: 29205625b42e4cdd7ada68d631596a785e865917567a3184c5be9ef70491c680
4
- data.tar.gz: b0c1b16c4906a60b02dade44259c22dc05b7098046e3cffecffdd84fdaafea0d
3
+ metadata.gz: 38e0d30723c5330604a92299f08080393c6eb5f426d479f0ca9e38418299344b
4
+ data.tar.gz: b0883b91b9b8679389d29438bb5f35ffdc062f18602432c635efd7493f620637
5
5
  SHA512:
6
- metadata.gz: 0e2614e051e202b4eefcdfd51937a4087fe0f91d63e97c7a5af1665cc3ccdae6c7b523322353357075d38abc1094dfae4aa20c70ff840ab93b93f0c651a9bd3e
7
- data.tar.gz: 2ff9b98cec4e0df97bbfaa39956adf024f52a36121bce9d38c5300d00e6dc7bdcac90f75833f70274bf6e1667be8bbe5a635f0a06859e76b704f2e0305cf87f3
6
+ metadata.gz: 60044a86bf85a4fb66f6d2335f7681adba34f0fd99e0b693e02f63d334a883d672b08d1031a5759b9db756fea07f2f7a6151f02c5e4cbbe81ba5e0479dc3af56
7
+ data.tar.gz: 532696f5192de8e0287e5882a59f54dd560d577617d57b6f7b200ae9df92cb4ffae533c7e03c74edccac63c7d7a6418839ca6b98a6123133a6648a68b352fa7a
@@ -1,3 +1,7 @@
1
+ ## 4.3.0
2
+ - Made `stale_cleanup_interval` configurable [#84](https://github.com/logstash-plugins/logstash-output-file/pull/84)
3
+ - CI: upgrade testing [#83](https://github.com/logstash-plugins/logstash-output-file/pull/83)
4
+
1
5
  ## 4.2.6
2
6
  - Removed JRuby check when using FIFOs [#75](https://github.com/logstash-plugins/logstash-output-file/pull/75)
3
7
 
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.
@@ -49,6 +49,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
49
49
  | <<plugins-{type}s-{plugin}-flush_interval>> |<<number,number>>|No
50
50
  | <<plugins-{type}s-{plugin}-gzip>> |<<boolean,boolean>>|No
51
51
  | <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
52
+ | <<plugins-{type}s-{plugin}-stale_cleanup_interval>> |<<number,number>>|No
52
53
  | <<plugins-{type}s-{plugin}-write_behavior>> |<<string,string>>|No
53
54
  |=======================================================================
54
55
 
@@ -132,6 +133,15 @@ E.g.: `path => "./test-%{+YYYY-MM-dd}.txt"` to create
132
133
  If you use an absolute path you cannot start with a dynamic string.
133
134
  E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths
134
135
 
136
+ [id="plugins-{type}s-{plugin}-stale_cleanup_interval"]
137
+ ===== `stale_cleanup_interval`
138
+
139
+ * Value type is <<number,number>>
140
+ * Default value is `10`
141
+
142
+ Defines the interval, in seconds, between the stale files cleanup runs.
143
+ The stale files cleanup cycle closes inactive files (i.e files not written to since the last cycle).
144
+
135
145
  [id="plugins-{type}s-{plugin}-write_behavior"]
136
146
  ===== `write_behavior`
137
147
 
@@ -140,8 +150,8 @@ E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths
140
150
 
141
151
  If `append`, the file will be opened for appending and each new event will be written at the end of the file.
142
152
  If `overwrite`, the file will be truncated before writing and only the most recent event will appear in the file.
143
-
144
153
  [id="plugins-{type}s-{plugin}-common-options"]
154
+
145
155
  include::{include_path}/{type}.asciidoc[]
146
156
 
147
- :default_codec!:
157
+ :default_codec!:
@@ -73,10 +73,14 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
73
73
  # If `overwrite`, the file will be truncated before writing and only the most
74
74
  # recent event will appear in the file.
75
75
  config :write_behavior, :validate => [ "overwrite", "append" ], :default => "append"
76
+
77
+ # How often should the stale files cleanup cycle run (in seconds).
78
+ # The stale files cleanup cycle closes inactive files (i.e files not written to since the last cycle).
79
+ config :stale_cleanup_interval, :validate => :number, :default => 10
80
+
76
81
 
77
82
  default :codec, "json_lines"
78
83
 
79
- public
80
84
  def register
81
85
  require "fileutils" # For mkdir_p
82
86
 
@@ -100,29 +104,8 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
100
104
  end
101
105
 
102
106
  @last_stale_cleanup_cycle = Time.now
103
- @stale_cleanup_interval = 10
104
- end # def register
105
-
106
- private
107
- def validate_path
108
- if (root_directory =~ FIELD_REF) != nil
109
- @logger.error("File: The starting part of the path should not be dynamic.", :path => @path)
110
- raise LogStash::ConfigurationError.new("The starting part of the path should not be dynamic.")
111
- end
112
- end
113
-
114
- private
115
- def root_directory
116
- parts = @path.split(File::SEPARATOR).select { |item| !item.empty? }
117
- if Gem.win_platform?
118
- # First part is the drive letter
119
- parts[1]
120
- else
121
- parts.first
122
- end
123
107
  end
124
108
 
125
- public
126
109
  def multi_receive_encoded(events_and_encoded)
127
110
  encoded_by_path = Hash.new {|h,k| h[k] = []}
128
111
 
@@ -147,9 +130,8 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
147
130
 
148
131
  close_stale_files
149
132
  end
150
- end # def receive
133
+ end
151
134
 
152
- public
153
135
  def close
154
136
  @flusher.stop unless @flusher.nil?
155
137
  @io_mutex.synchronize do
@@ -167,12 +149,29 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
167
149
  end
168
150
 
169
151
  private
152
+
153
+ def validate_path
154
+ if (root_directory =~ FIELD_REF) != nil
155
+ @logger.error("File: The starting part of the path should not be dynamic.", :path => @path)
156
+ raise LogStash::ConfigurationError.new("The starting part of the path should not be dynamic.")
157
+ end
158
+ end
159
+
160
+ def root_directory
161
+ parts = @path.split(File::SEPARATOR).select { |item| !item.empty? }
162
+ if Gem.win_platform?
163
+ # First part is the drive letter
164
+ parts[1]
165
+ else
166
+ parts.first
167
+ end
168
+ end
169
+
170
170
  def inside_file_root?(log_path)
171
171
  target_file = File.expand_path(log_path)
172
172
  return target_file.start_with?("#{@file_root.to_s}/")
173
173
  end
174
174
 
175
- private
176
175
  def event_path(event)
177
176
  file_output_path = generate_filepath(event)
178
177
  if path_with_field_ref? && !inside_file_root?(file_output_path)
@@ -186,24 +185,20 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
186
185
  file_output_path
187
186
  end
188
187
 
189
- private
190
188
  def generate_filepath(event)
191
189
  event.sprintf(@path)
192
190
  end
193
191
 
194
- private
195
192
  def path_with_field_ref?
196
193
  path =~ FIELD_REF
197
194
  end
198
195
 
199
- private
200
196
  def extract_file_root
201
197
  parts = File.expand_path(path).split(File::SEPARATOR)
202
198
  parts.take_while { |part| part !~ FIELD_REF }.join(File::SEPARATOR)
203
199
  end
204
200
 
205
201
  # the back-bone of @flusher, our periodic-flushing interval.
206
- private
207
202
  def flush_pending_files
208
203
  @io_mutex.synchronize do
209
204
  @logger.debug("Starting flush cycle")
@@ -219,7 +214,6 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
219
214
  end
220
215
 
221
216
  # every 10 seconds or so (triggered by events, but if there are no events there's no point closing files anyway)
222
- private
223
217
  def close_stale_files
224
218
  now = Time.now
225
219
  return unless now - @last_stale_cleanup_cycle >= @stale_cleanup_interval
@@ -237,17 +231,14 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
237
231
  @last_stale_cleanup_cycle = now
238
232
  end
239
233
 
240
- private
241
234
  def cached?(path)
242
235
  @files.include?(path) && !@files[path].nil?
243
236
  end
244
237
 
245
- private
246
238
  def deleted?(path)
247
239
  !File.exist?(path)
248
240
  end
249
241
 
250
- private
251
242
  def open(path)
252
243
  if !deleted?(path) && cached?(path)
253
244
  return @files[path]
@@ -362,24 +353,29 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
362
353
  ensure
363
354
  @sleeper.broadcast
364
355
  end
365
- end # class LogStash::Outputs::File::Interval
366
- end # class LogStash::Outputs::File
356
+ end
357
+ end
367
358
 
368
359
  # wrapper class
369
360
  class IOWriter
361
+ attr_accessor :active
362
+
370
363
  def initialize(io)
371
364
  @io = io
372
365
  end
366
+
373
367
  def write(*args)
374
368
  @io.write(*args)
375
369
  @active = true
376
370
  end
371
+
377
372
  def flush
378
373
  @io.flush
379
374
  if @io.class == Zlib::GzipWriter
380
375
  @io.to_io.flush
381
376
  end
382
377
  end
378
+
383
379
  def method_missing(method_name, *args, &block)
384
380
  if @io.respond_to?(method_name)
385
381
 
@@ -388,5 +384,4 @@ class IOWriter
388
384
  super
389
385
  end
390
386
  end
391
- attr_accessor :active
392
387
  end
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-output-file'
4
- s.version = '4.2.6'
4
+ s.version = '4.3.0'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Writes events to files on disk"
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"
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
25
25
  s.add_runtime_dependency 'logstash-codec-line'
26
26
 
27
27
  s.add_development_dependency 'logstash-devutils'
28
+ s.add_development_dependency 'insist'
28
29
  s.add_development_dependency 'flores'
29
30
  s.add_development_dependency 'logstash-input-generator'
30
31
  end
@@ -1,5 +1,6 @@
1
1
  # encoding: UTF-8
2
2
  require "logstash/devutils/rspec/spec_helper"
3
+ require "insist"
3
4
  require "logstash/outputs/file"
4
5
  require "logstash/codecs/line"
5
6
  require "logstash/codecs/json_lines"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-output-file
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.2.6
4
+ version: 4.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-02-05 00:00:00.000000000 Z
11
+ date: 2020-04-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
72
72
  - - ">="
73
73
  - !ruby/object:Gem::Version
74
74
  version: '0'
75
+ - !ruby/object:Gem::Dependency
76
+ requirement: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: '0'
81
+ name: insist
82
+ prerelease: false
83
+ type: :development
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
75
89
  - !ruby/object:Gem::Dependency
76
90
  requirement: !ruby/object:Gem::Requirement
77
91
  requirements: