logstash-input-s3 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71fa5a89a8d744412ab8ac15f60f4d7e59ff2800de976466450de5142962285e
-  data.tar.gz: 795c0caf4c280c90d4193aacacd8b09d64f33637859b3eda35349366862be9ba
+  metadata.gz: a6d9ab89a4d7925dbaaa02b021b1bbe803426a5c2e5285c1239d72950563fc27
+  data.tar.gz: 40aafdb8002e940fcc08f72d119299567dda77210dedcaf436df9a273858ecf1
 SHA512:
-  metadata.gz: 27be2ecb1234ba44fb4004b0a972d9cb643e9429df468d1777f189f3f207ce849d95b5655077343960edf2c4817254d4eb5ff9fb73c87afb99e0ce35c64e0f38
-  data.tar.gz: 243140b50837ed67fe8e30997f560e41cc66b7f9da3fd4c6668bb6345cedd911ed9d18c5deb07c594bd24a8caa6c4efc11a3c500e66656e782343b05405d40c6
+  metadata.gz: 12730fa07325e2549ac32c8b7a629464c3a1d789992c5e07bd3f1bf43ad11b353886882678d00c27a14a7e0e675eaaa4002187f5141d078308de8e3e480d67d3
+  data.tar.gz: 24c61bb4d995ef2615cf9ea769ad36d88965eb758e8a9d205394a887ca6f1cac47211e76c42c81e8499f1ab818e072ee50e52431de045e1018402af947f61df3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.5.0
+ - Added support for including objects restored from Glacier or Glacier Deep [#199](https://github.com/logstash-plugins/logstash-input-s3/issues/199)
+ - Added `gzip_pattern` option, enabling more flexible determination of whether a file is gzipped [#165](https://github.com/logstash-plugins/logstash-input-s3/issues/165)
+ - Refactor: log exception: class + unify logging messages a bit [#201](https://github.com/logstash-plugins/logstash-input-s3/pull/201)
+
 ## 3.4.1
  - Fixed link formatting for input type (documentation)
 

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/README.md

@@ -38,7 +38,7 @@ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/log
 
 ## Developing
 
-### 1. Plugin Developement and Testing
+### 1. Plugin Development and Testing
 
 #### Code
 - To get started, you'll need JRuby with the Bundler gem installed.

data/docs/index.asciidoc

@@ -46,6 +46,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-delete>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-endpoint>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-exclude_pattern>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-gzip_pattern>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-include_object_properties>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-prefix>> |<<string,string>>|No
@@ -158,6 +159,14 @@ guaranteed to work correctly with the AWS SDK.
 
 Ruby style regexp of keys to exclude from the bucket
 
+[id="plugins-{type}s-{plugin}-gzip_pattern"]
+===== `gzip_pattern`
+
+  * Value type is <<string,string>>
+  * Default value is `"\.gz(ip)?$"`
+
+Regular expression used to determine whether an input file is in gzip format.
+
 [id="plugins-{type}s-{plugin}-additional_settings"]
 ===== `additional_settings`
 
@@ -187,7 +196,7 @@ the connection to s3. See full list in https://docs.aws.amazon.com/sdkforruby/ap
   * Default value is `false`
 
 Whether or not to include the S3 object's properties (last_modified, content_type, metadata) into each Event at
-`[@metadata][s3]`. Regardless of this setting, `[@metdata][s3][key]` will always be present.
+`[@metadata][s3]`. Regardless of this setting, `[@metadata][s3][key]` will always be present.
 
 [id="plugins-{type}s-{plugin}-interval"]
 ===== `interval` 

data/lib/logstash/inputs/s3.rb

@@ -3,6 +3,7 @@ require "logstash/inputs/base"
 require "logstash/namespace"
 require "logstash/plugin_mixins/aws_config"
 require "time"
+require "date"
 require "tmpdir"
 require "stud/interval"
 require "stud/temporary"
@@ -10,12 +11,6 @@ require "aws-sdk"
 require "logstash/inputs/s3/patch"
 
 require 'java'
-java_import java.io.InputStream
-java_import java.io.InputStreamReader
-java_import java.io.FileInputStream
-java_import java.io.BufferedReader
-java_import java.util.zip.GZIPInputStream
-java_import java.util.zip.ZipException
 
 Aws.eager_autoload!
 # Stream events from files from a S3 bucket.
@@ -23,6 +18,14 @@ Aws.eager_autoload!
 # Each line from each file generates an event.
 # Files ending in `.gz` are handled as gzip'ed files.
 class LogStash::Inputs::S3 < LogStash::Inputs::Base
+
+  java_import java.io.InputStream
+  java_import java.io.InputStreamReader
+  java_import java.io.FileInputStream
+  java_import java.io.BufferedReader
+  java_import java.util.zip.GZIPInputStream
+  java_import java.util.zip.ZipException
+
   include LogStash::PluginMixins::AwsConfig::V2
 
   config_name "s3"
@@ -63,7 +66,7 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
   # Value is in seconds.
   config :interval, :validate => :number, :default => 60
 
-  # Whether to watch for new files with the interval. 
+  # Whether to watch for new files with the interval.
   # If false, overrides any interval and only lists the s3 bucket once.
   config :watch_for_new_files, :validate => :boolean, :default => true
 
@@ -79,13 +82,16 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
   # be present.
   config :include_object_properties, :validate => :boolean, :default => false
 
-  public
+  # Regular expression used to determine whether an input file is in gzip format.
+  # default to an expression that matches *.gz and *.gzip file extensions
+  config :gzip_pattern, :validate => :string, :default => "\.gz(ip)?$"
+
   def register
     require "fileutils"
     require "digest/md5"
     require "aws-sdk-resources"
 
-    @logger.info("Registering s3 input", :bucket => @bucket, :region => @region)
+    @logger.info("Registering", :bucket => @bucket, :region => @region)
 
     s3 = get_s3object
 
@@ -111,7 +117,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  public
   def run(queue)
     @current_thread = Thread.current
     Stud.interval(@interval) do
@@ -120,36 +125,33 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end # def run
 
-  public
   def list_new_files
     objects = {}
     found = false
     begin
       @s3bucket.objects(:prefix => @prefix).each do |log|
         found = true
-        @logger.debug("S3 input: Found key", :key => log.key)
+        @logger.debug('Found key', :key => log.key)
         if ignore_filename?(log.key)
-          @logger.debug('S3 input: Ignoring', :key => log.key)
+          @logger.debug('Ignoring', :key => log.key)
         elsif log.content_length <= 0
-          @logger.debug('S3 Input: Object Zero Length', :key => log.key)
+          @logger.debug('Object Zero Length', :key => log.key)
         elsif !sincedb.newer?(log.last_modified)
-          @logger.debug('S3 Input: Object Not Modified', :key => log.key)
-        elsif log.storage_class.start_with?('GLACIER')
-          @logger.debug('S3 Input: Object Archived to Glacier', :key => log.key)
+          @logger.debug('Object Not Modified', :key => log.key)
+        elsif (log.storage_class == 'GLACIER' || log.storage_class == 'DEEP_ARCHIVE') && !file_restored?(log.object)
+          @logger.debug('Object Archived to Glacier', :key => log.key)
         else
           objects[log.key] = log.last_modified
-          @logger.debug("S3 input: Adding to objects[]", :key => log.key)
-          @logger.debug("objects[] length is: ", :length => objects.length)
+          @logger.debug("Added to objects[]", :key => log.key, :length => objects.length)
         end
       end
-      @logger.info('S3 input: No files found in bucket', :prefix => prefix) unless found
+      @logger.info('No files found in bucket', :prefix => prefix) unless found
     rescue Aws::Errors::ServiceError => e
-      @logger.error("S3 input: Unable to list objects in bucket", :prefix => prefix, :message => e.message)
+      @logger.error("Unable to list objects in bucket", :exception => e.class, :message => e.message, :backtrace => e.backtrace, :prefix => prefix)
     end
     objects.keys.sort {|a,b| objects[a] <=> objects[b]}
   end # def fetch_new_files
 
-  public
   def backup_to_bucket(object)
     unless @backup_to_bucket.nil?
       backup_key = "#{@backup_add_prefix}#{object.key}"
@@ -160,14 +162,12 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  public
   def backup_to_dir(filename)
     unless @backup_to_dir.nil?
       FileUtils.cp(filename, @backup_to_dir)
     end
   end
 
-  public
   def process_files(queue)
     objects = list_new_files
 
@@ -175,13 +175,11 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
       if stop?
         break
       else
-        @logger.debug("S3 input processing", :bucket => @bucket, :key => key)
         process_log(queue, key)
       end
     end
   end # def process_files
 
-  public
   def stop
     # @current_thread is initialized in the `#run` method,
     # this variable is needed because the `#stop` is a called in another thread
@@ -248,24 +246,20 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     return true
   end # def process_local_log
 
-  private
   def event_is_metadata?(event)
     return false unless event.get("message").class == String
     line = event.get("message")
     version_metadata?(line) || fields_metadata?(line)
   end
 
-  private
   def version_metadata?(line)
     line.start_with?('#Version: ')
   end
 
-  private
   def fields_metadata?(line)
     line.start_with?('#Fields: ')
   end
 
-  private 
   def update_metadata(metadata, event)
     line = event.get('message').strip
 
@@ -278,7 +272,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
   def read_file(filename, &block)
     if gzip?(filename)
       read_gzip_file(filename, block)
@@ -287,7 +280,7 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   rescue => e
     # skip any broken file
-    @logger.error("Failed to read the file. Skip processing.", :filename => filename, :exception => e.message)
+    @logger.error("Failed to read file, processing skipped", :exception => e.class, :message => e.message, :filename => filename)
   end
 
   def read_plain_file(filename, block)
@@ -296,7 +289,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
   def read_gzip_file(filename, block)
     file_stream = FileInputStream.new(filename)
     gzip_stream = GZIPInputStream.new(file_stream)
@@ -313,24 +305,20 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     file_stream.close unless file_stream.nil?
   end
 
-  private
   def gzip?(filename)
-    filename.end_with?('.gz','.gzip')
+    Regexp.new(@gzip_pattern).match(filename)
   end
-  
-  private
-  def sincedb 
+
+  def sincedb
     @sincedb ||= if @sincedb_path.nil?
                     @logger.info("Using default generated file for the sincedb", :filename => sincedb_file)
                     SinceDB::File.new(sincedb_file)
                   else
-                    @logger.info("Using the provided sincedb_path",
-                                 :sincedb_path => @sincedb_path)
+                    @logger.info("Using the provided sincedb_path", :sincedb_path => @sincedb_path)
                     SinceDB::File.new(@sincedb_path)
                   end
   end
 
-  private
   def sincedb_file
     digest = Digest::MD5.hexdigest("#{@bucket}+#{@prefix}")
     dir = File.join(LogStash::SETTINGS.get_value("path.data"), "plugins", "inputs", "s3")
@@ -363,11 +351,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     symbolized
   end
 
-  private
-  def old_sincedb_file
-  end
-
-  private
   def ignore_filename?(filename)
     if @prefix == filename
       return true
@@ -384,8 +367,8 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
   def process_log(queue, key)
+    @logger.debug("Processing", :bucket => @bucket, :key => key)
     object = @s3bucket.object(key)
 
     filename = File.join(temporary_directory, File.basename(key))
@@ -403,7 +386,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
   # Stream the remove file to the local disk
   #
   # @param [S3Object] Reference to the remove S3 objec to download
@@ -411,33 +393,48 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
   # @return [Boolean] True if the file was completely downloaded
   def download_remote_file(remote_object, local_filename)
     completed = false
-    @logger.debug("S3 input: Download remote file", :remote_key => remote_object.key, :local_filename => local_filename)
+    @logger.debug("Downloading remote file", :remote_key => remote_object.key, :local_filename => local_filename)
     File.open(local_filename, 'wb') do |s3file|
       return completed if stop?
       begin
         remote_object.get(:response_target => s3file)
         completed = true
       rescue Aws::Errors::ServiceError => e
-        @logger.warn("S3 input: Unable to download remote file", :remote_key => remote_object.key, :message => e.message)
+        @logger.warn("Unable to download remote file", :exception => e.class, :message => e.message, :remote_key => remote_object.key)
       end
     end
     completed
   end
 
-  private
   def delete_file_from_bucket(object)
     if @delete and @backup_to_bucket.nil?
       object.delete()
     end
   end
 
-  private
   def get_s3object
     options = symbolized_settings.merge(aws_options_hash || {})
     s3 = Aws::S3::Resource.new(options)
   end
 
-  private
+  def file_restored?(object)
+    begin
+      restore = object.data.restore
+      if restore && restore.match(/ongoing-request\s?=\s?["']false["']/)
+        if restore = restore.match(/expiry-date\s?=\s?["'](.*?)["']/)
+          expiry_date = DateTime.parse(restore[1])
+          return true if DateTime.now < expiry_date # restored
+        else
+          @logger.debug("No expiry-date header for restore request: #{object.data.restore}")
+          return nil # no expiry-date found for ongoing request
+        end
+      end
+    rescue => e
+      @logger.debug("Could not determine Glacier restore status", :exception => e.class, :message => e.message)
+    end
+    return false
+  end
+
   module SinceDB
     class File
       def initialize(file)

data/logstash-input-s3.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-s3'
-  s.version         = '3.4.1'
+  s.version         = '3.5.0'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Streams events from files in a S3 bucket"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/s3_spec.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
 require "logstash/inputs/s3"
 require "logstash/codecs/multiline"
 require "logstash/errors"
@@ -114,13 +115,18 @@ describe LogStash::Inputs::S3 do
   describe "#list_new_files" do
     before { allow_any_instance_of(Aws::S3::Bucket).to receive(:objects) { objects_list } }
 
-    let!(:present_object) { double(:key => 'this-should-be-present', :last_modified => Time.now, :content_length => 10, :storage_class => 'STANDARD') }
-    let!(:archived_object) {double(:key => 'this-should-be-archived', :last_modified => Time.now, :content_length => 10, :storage_class => 'GLACIER') }
+    let!(:present_object) {double(:key => 'this-should-be-present', :last_modified => Time.now, :content_length => 10, :storage_class => 'STANDARD', :object => double(:data => double(:restore => nil)) ) }
+    let!(:archived_object) {double(:key => 'this-should-be-archived', :last_modified => Time.now, :content_length => 10, :storage_class => 'GLACIER', :object => double(:data => double(:restore => nil)) ) }
+    let!(:deep_archived_object) {double(:key => 'this-should-be-archived', :last_modified => Time.now, :content_length => 10, :storage_class => 'GLACIER', :object => double(:data => double(:restore => nil)) ) }
+    let!(:restored_object) {double(:key => 'this-should-be-restored-from-archive', :last_modified => Time.now, :content_length => 10, :storage_class => 'GLACIER', :object => double(:data => double(:restore => 'ongoing-request="false", expiry-date="Thu, 01 Jan 2099 00:00:00 GMT"')) ) }
+    let!(:deep_restored_object) {double(:key => 'this-should-be-restored-from-deep-archive', :last_modified => Time.now, :content_length => 10, :storage_class => 'DEEP_ARCHIVE', :object => double(:data => double(:restore => 'ongoing-request="false", expiry-date="Thu, 01 Jan 2099 00:00:00 GMT"')) ) }
     let(:objects_list) {
       [
         double(:key => 'exclude-this-file-1', :last_modified => Time.now - 2 * day, :content_length => 100, :storage_class => 'STANDARD'),
         double(:key => 'exclude/logstash', :last_modified => Time.now - 2 * day, :content_length => 50, :storage_class => 'STANDARD'),
         archived_object,
+        restored_object,
+        deep_restored_object,
         present_object
       ]
     }
@@ -131,10 +137,13 @@ describe LogStash::Inputs::S3 do
 
       files = plugin.list_new_files
       expect(files).to include(present_object.key)
+      expect(files).to include(restored_object.key)
+      expect(files).to include(deep_restored_object.key)
       expect(files).to_not include('exclude-this-file-1') # matches exclude pattern
       expect(files).to_not include('exclude/logstash')    # matches exclude pattern
       expect(files).to_not include(archived_object.key)   # archived
-      expect(files.size).to eq(1)
+      expect(files).to_not include(deep_archived_object.key)   # archived
+      expect(files.size).to eq(3)
     end
 
     it 'should support not providing a exclude pattern' do
@@ -143,10 +152,13 @@ describe LogStash::Inputs::S3 do
 
       files = plugin.list_new_files
       expect(files).to include(present_object.key)
+      expect(files).to include(restored_object.key)
+      expect(files).to include(deep_restored_object.key)
       expect(files).to include('exclude-this-file-1')   # no exclude pattern given
       expect(files).to include('exclude/logstash')      # no exclude pattern given
       expect(files).to_not include(archived_object.key) # archived
-      expect(files.size).to eq(3)
+      expect(files).to_not include(deep_archived_object.key)   # archived
+      expect(files.size).to eq(5)
     end
 
     context 'when all files are excluded from a bucket' do
@@ -208,10 +220,13 @@ describe LogStash::Inputs::S3 do
 
       files = plugin.list_new_files
       expect(files).to include(present_object.key)
+      expect(files).to include(restored_object.key)
+      expect(files).to include(deep_restored_object.key)
       expect(files).to_not include('exclude-this-file-1') # too old
       expect(files).to_not include('exclude/logstash')    # too old
       expect(files).to_not include(archived_object.key)   # archived
-      expect(files.size).to eq(1)
+      expect(files).to_not include(deep_archived_object.key) # archived
+      expect(files.size).to eq(3)
     end
 
     it 'should ignore file if the file match the prefix' do
@@ -301,7 +316,7 @@ describe LogStash::Inputs::S3 do
     it 'should process events' do
       events = fetch_events(config)
       expect(events.size).to eq(events_to_process)
-      insist { events[0].get("[@metadata][s3][key]") } == log.key
+      expect(events[0].get("[@metadata][s3][key]")).to eql log.key
     end
 
     it "deletes the temporary file" do
@@ -420,7 +435,7 @@ describe LogStash::Inputs::S3 do
         let(:events_to_process) { 16 }
       end
     end
-      
+
     context 'compressed' do
       let(:log) { double(:key => 'log.gz', :last_modified => Time.now - 2 * day, :content_length => 5, :storage_class => 'STANDARD') }
       let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'compressed.log.gz') }
@@ -428,13 +443,20 @@ describe LogStash::Inputs::S3 do
       include_examples "generated events"
     end
 
-    context 'compressed with gzip extension' do
+    context 'compressed with gzip extension and using default gzip_pattern option' do
       let(:log) { double(:key => 'log.gz', :last_modified => Time.now - 2 * day, :content_length => 5, :storage_class => 'STANDARD') }
       let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'compressed.log.gzip') }
 
       include_examples "generated events"
     end
 
+    context 'compressed with gzip extension and using custom gzip_pattern option' do
+      let(:config) { super.merge({ "gzip_pattern" => "gee.zip$" }) }
+      let(:log) { double(:key => 'log.gee.zip', :last_modified => Time.now - 2 * day, :content_length => 5, :storage_class => 'STANDARD') }
+      let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'compressed.log.gee.zip') }
+       include_examples "generated events"
+    end
+
     context 'plain text' do
       let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'uncompressed.log') }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-s3
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - lib/logstash/inputs/s3/patch.rb
 - logstash-input-s3.gemspec
 - spec/fixtures/cloudfront.log
+- spec/fixtures/compressed.log.gee.zip
 - spec/fixtures/compressed.log.gz
 - spec/fixtures/compressed.log.gzip
 - spec/fixtures/invalid_utf8.gbk.log
@@ -159,6 +160,7 @@ specification_version: 4
 summary: Streams events from files in a S3 bucket
 test_files:
 - spec/fixtures/cloudfront.log
+- spec/fixtures/compressed.log.gee.zip
 - spec/fixtures/compressed.log.gz
 - spec/fixtures/compressed.log.gzip
 - spec/fixtures/invalid_utf8.gbk.log