logstash-output-file 4.2.6 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29205625b42e4cdd7ada68d631596a785e865917567a3184c5be9ef70491c680
-  data.tar.gz: b0c1b16c4906a60b02dade44259c22dc05b7098046e3cffecffdd84fdaafea0d
+  metadata.gz: 38e0d30723c5330604a92299f08080393c6eb5f426d479f0ca9e38418299344b
+  data.tar.gz: b0883b91b9b8679389d29438bb5f35ffdc062f18602432c635efd7493f620637
 SHA512:
-  metadata.gz: 0e2614e051e202b4eefcdfd51937a4087fe0f91d63e97c7a5af1665cc3ccdae6c7b523322353357075d38abc1094dfae4aa20c70ff840ab93b93f0c651a9bd3e
-  data.tar.gz: 2ff9b98cec4e0df97bbfaa39956adf024f52a36121bce9d38c5300d00e6dc7bdcac90f75833f70274bf6e1667be8bbe5a635f0a06859e76b704f2e0305cf87f3
+  metadata.gz: 60044a86bf85a4fb66f6d2335f7681adba34f0fd99e0b693e02f63d334a883d672b08d1031a5759b9db756fea07f2f7a6151f02c5e4cbbe81ba5e0479dc3af56
+  data.tar.gz: 532696f5192de8e0287e5882a59f54dd560d577617d57b6f7b200ae9df92cb4ffae533c7e03c74edccac63c7d7a6418839ca6b98a6123133a6648a68b352fa7a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.3.0
+  - Made `stale_cleanup_interval` configurable [#84](https://github.com/logstash-plugins/logstash-output-file/pull/84)
+  - CI: upgrade testing [#83](https://github.com/logstash-plugins/logstash-output-file/pull/83)
+
 ## 4.2.6
   - Removed JRuby check when using FIFOs [#75](https://github.com/logstash-plugins/logstash-output-file/pull/75)
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/index.asciidoc

@@ -49,6 +49,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-flush_interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-gzip>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-stale_cleanup_interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-write_behavior>> |<<string,string>>|No
 |=======================================================================
 
@@ -132,6 +133,15 @@ E.g.: `path => "./test-%{+YYYY-MM-dd}.txt"` to create
 If you use an absolute path you cannot start with a dynamic string.
 E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths
 
+[id="plugins-{type}s-{plugin}-stale_cleanup_interval"]
+===== `stale_cleanup_interval`
+
+  * Value type is <<number,number>>
+  * Default value is `10`
+
+Defines the interval, in seconds, between the stale files cleanup runs.
+The stale files cleanup cycle closes inactive files (i.e files not written to since the last cycle).
+
 [id="plugins-{type}s-{plugin}-write_behavior"]
 ===== `write_behavior`
 
@@ -140,8 +150,8 @@ E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths
 
 If `append`, the file will be opened for appending and each new event will be written at the end of the file.
 If `overwrite`, the file will be truncated before writing and only the most recent event will appear in the file.
-
 [id="plugins-{type}s-{plugin}-common-options"]
+
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
+:default_codec!:

data/lib/logstash/outputs/file.rb

@@ -73,10 +73,14 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
   # If `overwrite`, the file will be truncated before writing and only the most
   # recent event will appear in the file.
   config :write_behavior, :validate => [ "overwrite", "append" ], :default => "append"
+  
+  # How often should the stale files cleanup cycle run (in seconds). 
+  # The stale files cleanup cycle closes inactive files (i.e files not written to since the last cycle).
+  config :stale_cleanup_interval, :validate => :number, :default => 10
+
 
   default :codec, "json_lines"
 
-  public
   def register
     require "fileutils" # For mkdir_p
 
@@ -100,29 +104,8 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
     end
 
     @last_stale_cleanup_cycle = Time.now
-    @stale_cleanup_interval = 10
-  end # def register
-
-  private
-  def validate_path
-    if (root_directory =~ FIELD_REF) != nil
-      @logger.error("File: The starting part of the path should not be dynamic.", :path => @path)
-      raise LogStash::ConfigurationError.new("The starting part of the path should not be dynamic.")
-    end
-  end
-
-  private
-  def root_directory
-    parts = @path.split(File::SEPARATOR).select { |item| !item.empty?  }
-    if Gem.win_platform?
-      # First part is the drive letter
-      parts[1]
-    else
-      parts.first
-    end
   end
 
-  public
   def multi_receive_encoded(events_and_encoded)
     encoded_by_path = Hash.new {|h,k| h[k] = []}
 
@@ -147,9 +130,8 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
 
       close_stale_files
     end
-  end # def receive
+  end
 
-  public
   def close
     @flusher.stop unless @flusher.nil?
     @io_mutex.synchronize do
@@ -167,12 +149,29 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
   end
 
   private
+
+  def validate_path
+    if (root_directory =~ FIELD_REF) != nil
+      @logger.error("File: The starting part of the path should not be dynamic.", :path => @path)
+      raise LogStash::ConfigurationError.new("The starting part of the path should not be dynamic.")
+    end
+  end
+
+  def root_directory
+    parts = @path.split(File::SEPARATOR).select { |item| !item.empty?  }
+    if Gem.win_platform?
+      # First part is the drive letter
+      parts[1]
+    else
+      parts.first
+    end
+  end
+
   def inside_file_root?(log_path)
     target_file = File.expand_path(log_path)
     return target_file.start_with?("#{@file_root.to_s}/")
   end
 
-  private
   def event_path(event)
     file_output_path = generate_filepath(event)
     if path_with_field_ref? && !inside_file_root?(file_output_path)
@@ -186,24 +185,20 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
     file_output_path
   end
 
-  private
   def generate_filepath(event)
     event.sprintf(@path)
   end
 
-  private
   def path_with_field_ref?
     path =~ FIELD_REF
   end
 
-  private
   def extract_file_root
     parts = File.expand_path(path).split(File::SEPARATOR)
     parts.take_while { |part| part !~ FIELD_REF }.join(File::SEPARATOR)
   end
 
   # the back-bone of @flusher, our periodic-flushing interval.
-  private
   def flush_pending_files
     @io_mutex.synchronize do
       @logger.debug("Starting flush cycle")
@@ -219,7 +214,6 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
   end
 
   # every 10 seconds or so (triggered by events, but if there are no events there's no point closing files anyway)
-  private
   def close_stale_files
     now = Time.now
     return unless now - @last_stale_cleanup_cycle >= @stale_cleanup_interval
@@ -237,17 +231,14 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
     @last_stale_cleanup_cycle = now
   end
 
-  private
   def cached?(path)
     @files.include?(path) && !@files[path].nil?
   end
 
-  private
   def deleted?(path)
     !File.exist?(path)
   end
 
-  private
   def open(path)
     if !deleted?(path) && cached?(path)
       return @files[path]
@@ -362,24 +353,29 @@ class LogStash::Outputs::File < LogStash::Outputs::Base
     ensure
       @sleeper.broadcast
     end
-  end # class LogStash::Outputs::File::Interval
-end # class LogStash::Outputs::File
+  end
+end
 
 # wrapper class
 class IOWriter
+  attr_accessor :active
+
   def initialize(io)
     @io = io
   end
+
   def write(*args)
     @io.write(*args)
     @active = true
   end
+
   def flush
     @io.flush
     if @io.class == Zlib::GzipWriter
       @io.to_io.flush
     end
   end
+
   def method_missing(method_name, *args, &block)
     if @io.respond_to?(method_name)
 
@@ -388,5 +384,4 @@ class IOWriter
       super
     end
   end
-  attr_accessor :active
 end

data/logstash-output-file.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-file'
-  s.version         = '4.2.6'
+  s.version         = '4.3.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Writes events to files on disk"
   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|
   s.add_runtime_dependency 'logstash-codec-line'
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'insist'
   s.add_development_dependency 'flores'
   s.add_development_dependency 'logstash-input-generator'
 end

data/spec/outputs/file_spec.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 require "logstash/devutils/rspec/spec_helper"
+require "insist"
 require "logstash/outputs/file"
 require "logstash/codecs/line"
 require "logstash/codecs/json_lines"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-file
 version: !ruby/object:Gem::Version
-  version: 4.2.6
+  version: 4.3.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: insist
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: