logstash-input-s3 3.3.6 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d02e0410e180a35672fc42215f5758ab34592b0acbac20caeedc3b2c555f8c
-  data.tar.gz: 5010dba8d504458b455a4941db2de4accd039b8ff47eeeb31da4059d0580847f
+  metadata.gz: a4e1cc2ba334eb9e35fc68cc6a773e13b9b7de5bc6c3b4ee40cf98903d140323
+  data.tar.gz: a43fe645c1016095639e092fa4d3e8e8b77384dd17190a712a0eaa5163e68854
 SHA512:
-  metadata.gz: 57ad952479ee8ac3a8582898f630e1db633101a595693566dd7697f4f70b7fc74568f1ab6da95e9498bae49f73dc6a4d76e96b28d677eab492965fc70e948f99
-  data.tar.gz: 34d23aebf95e88011d9bb6c2d4e6a14a2e7fc8110003672c9c703613bcbba095f5311043906022fcec443424b865c87b48d49682a13d5667d7fd5184deadb949
+  metadata.gz: e10a6e21aa62270ce5f78c269fb3abf0a28b0755f78b0cb7adcc76183be460472327bdabbc94fab51c35774ae930d25846084ad3b9b0e95bd9e021c995c08bbd
+  data.tar.gz: 23b6882049688b1cd57ccba4b8aa247103bf5b9f91011f1aa426e81280c3b4ca701bf88fd96e278968c7e38fd58a01980a830b4ce2bb9ad8e034cfe07113de79

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 3.6.0
+ - Fixed unprocessed file with the same `last_modified` in ingestion. [#220](https://github.com/logstash-plugins/logstash-input-s3/pull/220)
+
+## 3.5.2
+ - [DOC]Added note that only AWS S3 is supported. No other S3 compatible storage solutions are supported. [#208](https://github.com/logstash-plugins/logstash-input-s3/issues/208)
+
+## 3.5.1
+ - [DOC]Added example for `exclude_pattern` and reordered option descriptions [#204](https://github.com/logstash-plugins/logstash-input-s3/issues/204)
+ 
+## 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)
+
+## 3.4.0
+ - Skips objects that are archived to AWS Glacier with a helpful log message (previously they would log as matched, but then fail to load events) [#160](https://github.com/logstash-plugins/logstash-input-s3/pull/160)
+ - Added `watch_for_new_files` option, enabling single-batch imports [#159](https://github.com/logstash-plugins/logstash-input-s3/pull/159)
+
+## 3.3.7
+  - Added ability to optionally include S3 object properties inside @metadata [#155](https://github.com/logstash-plugins/logstash-input-s3/pull/155)
+
 ## 3.3.6
   - Fixed error in documentation by removing illegal commas [#154](https://github.com/logstash-plugins/logstash-input-s3/pull/154)
 

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

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-s3.svg)](https://travis-ci.org/logstash-plugins/logstash-input-s3)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-s3.svg)](https://travis-ci.com/logstash-plugins/logstash-input-s3)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -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

@@ -23,9 +23,14 @@ include::{include_path}/plugin_header.asciidoc[]
 
 Stream events from files from a S3 bucket.
 
+IMPORTANT: The S3 input plugin only supports AWS S3. 
+Other S3 compatible storage solutions are not supported.
+
 Each line from each file generates an event.
 Files ending in `.gz` are handled as gzip'ed files.
 
+Files that are archived to AWS Glacier will be skipped.
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== S3 Input Configuration Options
 
@@ -44,6 +49,8 @@ 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
 | <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
@@ -54,6 +61,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-temporary_directory>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-watch_for_new_files>> |<<boolean,boolean>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -75,6 +83,29 @@ This plugin uses the AWS SDK and supports several ways to get credentials, which
 4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
 5. IAM Instance Profile (available when running inside EC2)
 
+
+[id="plugins-{type}s-{plugin}-additional_settings"]
+===== `additional_settings`
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Key-value pairs of settings and corresponding values used to parametrize
+the connection to s3. See full list in https://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html[the AWS SDK documentation]. Example:
+
+[source,ruby]
+    input {
+      s3 {
+        "access_key_id" => "1234"
+        "secret_access_key" => "secret"
+        "bucket" => "logstash-test"
+        "additional_settings" => {
+          "force_path_style" => true
+          "follow_redirects" => false
+        }
+      }
+    }
+
 [id="plugins-{type}s-{plugin}-aws_credentials_file"]
 ===== `aws_credentials_file` 
 
@@ -152,29 +183,37 @@ guaranteed to work correctly with the AWS SDK.
   * Value type is <<string,string>>
   * Default value is `nil`
 
-Ruby style regexp of keys to exclude from the bucket
-
-[id="plugins-{type}s-{plugin}-additional_settings"]
-===== `additional_settings`
+Ruby style regexp of keys to exclude from the bucket.
 
-  * Value type is <<hash,hash>>
-  * Default value is `{}`
+Note that files matching the pattern are skipped _after_ they have been listed. 
+Consider using <<plugins-{type}s-{plugin}-prefix>> instead where possible.
 
-Key-value pairs of settings and corresponding values used to parametrize
-the connection to s3. See full list in https://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html[the AWS SDK documentation]. Example:
+Example:
 
 [source,ruby]
-    input {
-      s3 {
-        "access_key_id" => "1234"
-        "secret_access_key" => "secret"
-        "bucket" => "logstash-test"
-        "additional_settings" => {
-          "force_path_style" => true
-          "follow_redirects" => false
-        }
-      }
-    }
+-----
+"exclude_pattern" => "\/2020\/04\/"
+-----
+
+This pattern excludes all logs containing "/2020/04/" in the path.
+
+
+[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}-include_object_properties"]
+===== `include_object_properties`
+
+  * Value type is <<boolean,boolean>>
+  * 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, `[@metadata][s3][key]` will always be present.
 
 [id="plugins-{type}s-{plugin}-interval"]
 ===== `interval` 
@@ -263,7 +302,14 @@ If specified, this setting must be a filename path and not just a directory.
 
 Set the directory where logstash will store the tmp files before processing them.
 
+[id="plugins-{type}s-{plugin}-watch_for_new_files"]
+===== `watch_for_new_files`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
 
+Whether or not to watch for new files.
+Disabling this option causes the input to close itself after processing the files from a single listing.
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

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,6 +66,10 @@ 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.
+  # If false, overrides any interval and only lists the s3 bucket once.
+  config :watch_for_new_files, :validate => :boolean, :default => true
+
   # Ruby style regexp of keys to exclude from the bucket
   config :exclude_pattern, :validate => :string, :default => nil
 
@@ -70,13 +77,23 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
   # default to the current OS temporary directory in linux /tmp/logstash
   config :temporary_directory, :validate => :string, :default => File.join(Dir.tmpdir, "logstash")
 
-  public
+  # 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.
+  config :include_object_properties, :validate => :boolean, :default => false
+
+  # 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)?$"
+
+  CUTOFF_SECOND = 3
+
   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
 
@@ -96,42 +113,49 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
 
     FileUtils.mkdir_p(@temporary_directory) unless Dir.exist?(@temporary_directory)
+
+    if !@watch_for_new_files && original_params.include?('interval')
+      logger.warn("`watch_for_new_files` has been disabled; `interval` directive will be ignored.")
+    end
   end
 
-  public
   def run(queue)
     @current_thread = Thread.current
     Stud.interval(@interval) do
       process_files(queue)
+      stop unless @watch_for_new_files
     end
   end # def run
 
-  public
   def list_new_files
-    objects = {}
+    objects = []
     found = false
     begin
       @s3bucket.objects(:prefix => @prefix).each do |log|
         found = true
-        @logger.debug("S3 input: Found key", :key => log.key)
-        if !ignore_filename?(log.key)
-          if sincedb.newer?(log.last_modified) && log.content_length > 0
-            objects[log.key] = log.last_modified
-            @logger.debug("S3 input: Adding to objects[]", :key => log.key)
-            @logger.debug("objects[] length is: ", :length => objects.length)
-          end
+        @logger.debug('Found key', :key => log.key)
+        if ignore_filename?(log.key)
+          @logger.debug('Ignoring', :key => log.key)
+        elsif log.content_length <= 0
+          @logger.debug('Object Zero Length', :key => log.key)
+        elsif !sincedb.newer?(log.last_modified)
+          @logger.debug('Object Not Modified', :key => log.key)
+        elsif log.last_modified > (Time.now - CUTOFF_SECOND).utc # file modified within last two seconds will be processed in next cycle
+          @logger.debug('Object Modified After Cutoff Time', :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
-          @logger.debug('S3 input: Ignoring', :key => log.key)
+          objects << log
+          @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]}
+    objects.sort_by { |log| log.last_modified }
   end # def fetch_new_files
 
-  public
   def backup_to_bucket(object)
     unless @backup_to_bucket.nil?
       backup_key = "#{@backup_add_prefix}#{object.key}"
@@ -142,28 +166,24 @@ 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
 
-    objects.each do |key|
+    objects.each do |log|
       if stop?
         break
       else
-        @logger.debug("S3 input processing", :bucket => @bucket, :key => key)
-        process_log(queue, key)
+        process_log(queue, log)
       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
@@ -177,8 +197,9 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
   #
   # @param [Queue] Where to push the event
   # @param [String] Which file to read from
+  # @param [S3Object] Source s3 object
   # @return [Boolean] True if the file was completely read, false otherwise.
-  def process_local_log(queue, filename, key)
+  def process_local_log(queue, filename, object)
     @logger.debug('Processing file', :filename => filename)
     metadata = {}
     # Currently codecs operates on bytes instead of stream.
@@ -209,7 +230,13 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
           event.set("cloudfront_version", metadata[:cloudfront_version]) unless metadata[:cloudfront_version].nil?
           event.set("cloudfront_fields", metadata[:cloudfront_fields]) unless metadata[:cloudfront_fields].nil?
 
-          event.set("[@metadata][s3]", { "key" => key })
+          if @include_object_properties
+            event.set("[@metadata][s3]", object.data.to_h)
+          else
+            event.set("[@metadata][s3]", {})
+          end
+
+          event.set("[@metadata][s3][key]", object.key)
 
           queue << event
         end
@@ -223,24 +250,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
 
@@ -253,7 +276,6 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
   def read_file(filename, &block)
     if gzip?(filename)
       read_gzip_file(filename, block)
@@ -262,7 +284,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)
@@ -271,7 +293,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)
@@ -288,24 +309,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")
@@ -338,11 +355,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
@@ -359,26 +371,28 @@ class LogStash::Inputs::S3 < LogStash::Inputs::Base
     end
   end
 
-  private
-  def process_log(queue, key)
-    object = @s3bucket.object(key)
+  def process_log(queue, log)
+    @logger.debug("Processing", :bucket => @bucket, :key => log.key)
+    object = @s3bucket.object(log.key)
 
-    filename = File.join(temporary_directory, File.basename(key))
+    filename = File.join(temporary_directory, File.basename(log.key))
     if download_remote_file(object, filename)
-      if process_local_log(queue, filename, key)
-        lastmod = object.last_modified
-        backup_to_bucket(object)
-        backup_to_dir(filename)
-        delete_file_from_bucket(object)
-        FileUtils.remove_entry_secure(filename, true)
-        sincedb.write(lastmod)
+      if process_local_log(queue, filename, object)
+        if object.last_modified == log.last_modified
+          backup_to_bucket(object)
+          backup_to_dir(filename)
+          delete_file_from_bucket(object)
+          FileUtils.remove_entry_secure(filename, true)
+          sincedb.write(log.last_modified)
+        else
+          @logger.info("#{log.key} is updated at #{object.last_modified} and will process in the next cycle")
+        end
       end
     else
       FileUtils.remove_entry_secure(filename, true)
     end
   end
 
-  private
   # Stream the remove file to the local disk
   #
   # @param [S3Object] Reference to the remove S3 objec to download
@@ -386,33 +400,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.3.6'
+  s.version         = '3.6.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"
@@ -23,6 +24,7 @@ describe LogStash::Inputs::S3 do
       "sincedb_path" => File.join(sincedb_path, ".sincedb")
     }
   }
+  let(:cutoff) { LogStash::Inputs::S3::CUTOFF_SECOND }
 
 
   before do
@@ -32,10 +34,11 @@ describe LogStash::Inputs::S3 do
   end
 
   context "when interrupting the plugin" do
-    let(:config) { super.merge({ "interval" => 5 }) }
+    let(:config) { super().merge({ "interval" => 5 }) }
+    let(:s3_obj) { double(:key => "awesome-key", :last_modified => Time.now.round, :content_length => 10, :storage_class => 'STANDARD', :object => double(:data => double(:restore => nil)) ) }
 
     before do
-      expect_any_instance_of(LogStash::Inputs::S3).to receive(:list_new_files).and_return(TestInfiniteS3Object.new)
+      expect_any_instance_of(LogStash::Inputs::S3).to receive(:list_new_files).and_return(TestInfiniteS3Object.new(s3_obj))
     end
 
     it_behaves_like "an interruptible input plugin"
@@ -114,32 +117,61 @@ 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) }
+    let!(:present_object_after_cutoff) {double(:key => 'this-should-not-be-present', :last_modified => Time.now, :content_length => 10, :storage_class => 'STANDARD', :object => double(:data => double(:restore => nil)) ) }
+    let!(:present_object) {double(:key => 'this-should-be-present', :last_modified => Time.now - cutoff, :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  - cutoff, :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 - cutoff, :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  - cutoff, :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  - cutoff, :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),
-        double(:key => 'exclude/logstash', :last_modified => Time.now - 2 * day, :content_length => 50),
-        present_object
+        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,
+        present_object_after_cutoff
       ]
     }
 
     it 'should allow user to exclude files from the s3 bucket' do
       plugin = LogStash::Inputs::S3.new(config.merge({ "exclude_pattern" => "^exclude" }))
       plugin.register
-      expect(plugin.list_new_files).to eq([present_object.key])
+
+      files = plugin.list_new_files.map { |item| item.key }
+      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).to_not include(deep_archived_object.key)   # archived
+      expect(files).to_not include(present_object_after_cutoff.key)   # after cutoff
+      expect(files.size).to eq(3)
     end
 
     it 'should support not providing a exclude pattern' do
       plugin = LogStash::Inputs::S3.new(config)
       plugin.register
-      expect(plugin.list_new_files).to eq(objects_list.map(&:key))
+
+      files = plugin.list_new_files.map { |item| item.key }
+      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).to_not include(deep_archived_object.key)   # archived
+      expect(files).to_not include(present_object_after_cutoff.key)   # after cutoff
+      expect(files.size).to eq(5)
     end
 
     context 'when all files are excluded from a bucket' do
       let(:objects_list) {
         [
-            double(:key => 'exclude-this-file-1', :last_modified => Time.now - 2 * day, :content_length => 100),
-            double(:key => 'exclude/logstash', :last_modified => Time.now - 2 * day, :content_length => 50),
+            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'),
         ]
       }
 
@@ -168,7 +200,7 @@ describe LogStash::Inputs::S3 do
     context "If the bucket is the same as the backup bucket" do
       it 'should ignore files from the bucket if they match the backup prefix' do
         objects_list = [
-          double(:key => 'mybackup-log-1', :last_modified => Time.now, :content_length => 5),
+          double(:key => 'mybackup-log-1', :last_modified => Time.now, :content_length => 5, :storage_class => 'STANDARD'),
           present_object
         ]
 
@@ -177,24 +209,38 @@ describe LogStash::Inputs::S3 do
         plugin = LogStash::Inputs::S3.new(config.merge({ 'backup_add_prefix' => 'mybackup',
                                                          'backup_to_bucket' => config['bucket']}))
         plugin.register
-        expect(plugin.list_new_files).to eq([present_object.key])
+
+        files = plugin.list_new_files.map { |item| item.key }
+        expect(files).to include(present_object.key)
+        expect(files).to_not include('mybackup-log-1') # matches backup prefix
+        expect(files.size).to eq(1)
       end
     end
 
     it 'should ignore files older than X' do
       plugin = LogStash::Inputs::S3.new(config.merge({ 'backup_add_prefix' => 'exclude-this-file'}))
 
-      expect_any_instance_of(LogStash::Inputs::S3::SinceDB::File).to receive(:read).exactly(objects_list.size) { Time.now - day }
+
+      allow_any_instance_of(LogStash::Inputs::S3::SinceDB::File).to receive(:read).and_return(Time.now - day)
       plugin.register
 
-      expect(plugin.list_new_files).to eq([present_object.key])
+      files = plugin.list_new_files.map { |item| item.key }
+      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).to_not include(deep_archived_object.key) # archived
+      expect(files).to_not include(present_object_after_cutoff.key)   # after cutoff
+      expect(files.size).to eq(3)
     end
 
     it 'should ignore file if the file match the prefix' do
         prefix = 'mysource/'
 
         objects_list = [
-          double(:key => prefix, :last_modified => Time.now, :content_length => 5),
+          double(:key => prefix, :last_modified => Time.now, :content_length => 5, :storage_class => 'STANDARD'),
           present_object
         ]
 
@@ -202,14 +248,15 @@ describe LogStash::Inputs::S3 do
 
         plugin = LogStash::Inputs::S3.new(config.merge({ 'prefix' => prefix }))
         plugin.register
-        expect(plugin.list_new_files).to eq([present_object.key])
+        expect(plugin.list_new_files.map { |item| item.key }).to eq([present_object.key])
     end
 
     it 'should sort return object sorted by last_modification date with older first' do
       objects = [
-        double(:key => 'YESTERDAY', :last_modified => Time.now - day, :content_length => 5),
-        double(:key => 'TODAY', :last_modified => Time.now, :content_length => 5),
-        double(:key => 'TWO_DAYS_AGO', :last_modified => Time.now - 2 * day, :content_length => 5)
+        double(:key => 'YESTERDAY', :last_modified => Time.now - day, :content_length => 5, :storage_class => 'STANDARD'),
+        double(:key => 'TODAY', :last_modified => Time.now, :content_length => 5, :storage_class => 'STANDARD'),
+        double(:key => 'TODAY_BEFORE_CUTOFF', :last_modified => Time.now - cutoff, :content_length => 5, :storage_class => 'STANDARD'),
+        double(:key => 'TWO_DAYS_AGO', :last_modified => Time.now - 2 * day, :content_length => 5, :storage_class => 'STANDARD')
       ]
 
       allow_any_instance_of(Aws::S3::Bucket).to receive(:objects) { objects }
@@ -217,7 +264,7 @@ describe LogStash::Inputs::S3 do
 
       plugin = LogStash::Inputs::S3.new(config)
       plugin.register
-      expect(plugin.list_new_files).to eq(['TWO_DAYS_AGO', 'YESTERDAY', 'TODAY'])
+      expect(plugin.list_new_files.map { |item| item.key }).to eq(['TWO_DAYS_AGO', 'YESTERDAY', 'TODAY_BEFORE_CUTOFF'])
     end
 
     describe "when doing backup on the s3" do
@@ -277,7 +324,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
@@ -315,7 +362,7 @@ describe LogStash::Inputs::S3 do
     %w(AccessDenied NoSuchKey).each do |error|
       context "when retrieving an object, #{error} is returned" do
         let(:objects) { [log] }
-        let(:log) { double(:key => 'uncompressed.log', :last_modified => Time.now - 2 * day, :content_length => 5) }
+        let(:log) { double(:key => 'uncompressed.log', :last_modified => Time.now - 2 * day, :content_length => 5, :storage_class => 'STANDARD') }
 
         let(:config) {
           {
@@ -344,7 +391,7 @@ describe LogStash::Inputs::S3 do
 
   context 'when working with logs' do
     let(:objects) { [log] }
-    let(:log) { double(:key => 'uncompressed.log', :last_modified => Time.now - 2 * day, :content_length => 5) }
+    let(:log) { double(:key => 'uncompressed.log', :last_modified => Time.now - 2 * day, :content_length => 5, :data => { "etag" => 'c2c966251da0bc3229d12c2642ba50a4' }, :storage_class => 'STANDARD') }
     let(:data) { File.read(log_file) }
 
     before do
@@ -389,28 +436,35 @@ describe LogStash::Inputs::S3 do
     end
 
     context "multiple compressed streams" do
-      let(:log) { double(:key => 'log.gz', :last_modified => Time.now - 2 * day, :content_length => 5) }
+      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', 'multiple_compressed_streams.gz') }
 
       include_examples "generated events" 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) }
+      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') }
 
       include_examples "generated events"
     end
 
-    context 'compressed with gzip extension' do
-      let(:log) { double(:key => 'log.gz', :last_modified => Time.now - 2 * day, :content_length => 5) }
+    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') }
 
@@ -451,5 +505,95 @@ describe LogStash::Inputs::S3 do
 
       include_examples "generated events"
     end
+
+    context 'when include_object_properties is set to true' do
+      let(:config) { super().merge({ "include_object_properties" => true }) }
+      let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'uncompressed.log') }
+
+      it 'should extract object properties onto [@metadata][s3]' do
+        events = fetch_events(config)
+        events.each do |event|
+          expect(event.get('[@metadata][s3]')).to include(log.data)
+        end
+      end
+
+      include_examples "generated events"
+    end
+
+    context 'when include_object_properties is set to false' do
+      let(:config) { super().merge({ "include_object_properties" => false }) }
+      let(:log_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'uncompressed.log') }
+
+      it 'should NOT extract object properties onto [@metadata][s3]' do
+        events = fetch_events(config)
+        events.each do |event|
+          expect(event.get('[@metadata][s3]')).to_not include(log.data)
+        end
+      end
+
+      include_examples "generated events"
+    end
+  end
+
+  describe "data loss" do
+    let(:s3_plugin) { LogStash::Inputs::S3.new(config) }
+    let(:queue) { [] }
+
+    before do
+      s3_plugin.register
+    end
+
+    context 'events come after cutoff time' do
+      it 'should be processed in next cycle' do
+        s3_objects = [
+          double(:key => 'TWO_DAYS_AGO', :last_modified => Time.now.round - 2 * day, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'YESTERDAY', :last_modified => Time.now.round - day, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'TODAY_BEFORE_CUTOFF', :last_modified => Time.now.round - cutoff, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'TODAY', :last_modified => Time.now.round, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'TODAY', :last_modified => Time.now.round, :content_length => 5, :storage_class => 'STANDARD')
+        ]
+        size = s3_objects.length
+
+        allow_any_instance_of(Aws::S3::Bucket).to receive(:objects) { s3_objects }
+        allow_any_instance_of(Aws::S3::Bucket).to receive(:object).and_return(*s3_objects)
+        expect(s3_plugin).to receive(:process_log).at_least(size).and_call_original
+        expect(s3_plugin).to receive(:stop?).and_return(false).at_least(size)
+        expect(s3_plugin).to receive(:download_remote_file).and_return(true).at_least(size)
+        expect(s3_plugin).to receive(:process_local_log).and_return(true).at_least(size)
+
+        # first iteration
+        s3_plugin.process_files(queue)
+
+        # second iteration
+        sleep(cutoff + 1)
+        s3_plugin.process_files(queue)
+      end
+    end
+
+    context 's3 object updated after getting summary' do
+      it 'should not update sincedb' do
+        s3_summary = [
+          double(:key => 'YESTERDAY', :last_modified => Time.now.round - day, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'TODAY', :last_modified => Time.now.round - (cutoff * 10), :content_length => 5, :storage_class => 'STANDARD')
+        ]
+
+        s3_objects = [
+          double(:key => 'YESTERDAY', :last_modified => Time.now.round - day, :content_length => 5, :storage_class => 'STANDARD'),
+          double(:key => 'TODAY_UPDATED', :last_modified => Time.now.round, :content_length => 5, :storage_class => 'STANDARD')
+        ]
+
+        size = s3_objects.length
+
+        allow_any_instance_of(Aws::S3::Bucket).to receive(:objects) { s3_summary }
+        allow_any_instance_of(Aws::S3::Bucket).to receive(:object).and_return(*s3_objects)
+        expect(s3_plugin).to receive(:process_log).at_least(size).and_call_original
+        expect(s3_plugin).to receive(:stop?).and_return(false).at_least(size)
+        expect(s3_plugin).to receive(:download_remote_file).and_return(true).at_least(size)
+        expect(s3_plugin).to receive(:process_local_log).and_return(true).at_least(size)
+
+        s3_plugin.process_files(queue)
+        expect(s3_plugin.send(:sincedb).read).to eq(s3_summary[0].last_modified)
+      end
+    end
   end
 end

data/spec/integration/s3_spec.rb

@@ -10,6 +10,7 @@ describe LogStash::Inputs::S3, :integration => true, :s3 => true do
 
     upload_file('../fixtures/uncompressed.log' , "#{prefix}uncompressed_1.log")
     upload_file('../fixtures/compressed.log.gz', "#{prefix}compressed_1.log.gz")
+    sleep(LogStash::Inputs::S3::CUTOFF_SECOND + 1)
   end
 
   after do
@@ -28,6 +29,7 @@ describe LogStash::Inputs::S3, :integration => true, :s3 => true do
                                "prefix" => prefix,
                                "temporary_directory" => temporary_directory } }
   let(:backup_prefix) { "backup/" }
+  let(:backup_bucket) { "logstash-s3-input-backup" }
 
   it "support prefix to scope the remote files" do
     events = fetch_events(minimal_settings)
@@ -49,13 +51,17 @@ describe LogStash::Inputs::S3, :integration => true, :s3 => true do
   end
 
   context "remote backup" do
+    before do
+      create_bucket(backup_bucket)
+    end
+
     it "another bucket" do
-      fetch_events(minimal_settings.merge({ "backup_to_bucket" => "logstash-s3-input-backup"}))
-      expect(list_remote_files("", "logstash-s3-input-backup").size).to eq(2)
+      fetch_events(minimal_settings.merge({ "backup_to_bucket" => backup_bucket}))
+      expect(list_remote_files("", backup_bucket).size).to eq(2)
     end
 
     after do
-      delete_bucket("logstash-s3-input-backup")
+      delete_bucket(backup_bucket)
     end
   end
 end

data/spec/support/helpers.rb

@@ -23,6 +23,10 @@ def list_remote_files(prefix, target_bucket = ENV['AWS_LOGSTASH_TEST_BUCKET'])
   bucket.objects(:prefix => prefix).collect(&:key)
 end
 
+def create_bucket(name)
+  s3object.bucket(name).create
+end
+
 def delete_bucket(name)
   s3object.bucket(name).objects.map(&:delete)
   s3object.bucket(name).delete
@@ -33,13 +37,16 @@ def s3object
 end
 
 class TestInfiniteS3Object
+  def initialize(s3_obj)
+    @s3_obj = s3_obj
+  end
+
   def each
     counter = 1
 
     loop do
-      yield "awesome-#{counter}"
+      yield @s3_obj
       counter +=1
     end
   end
-end
-
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-s3
 version: !ruby/object:Gem::Version
-  version: 3.3.6
+  version: 3.6.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2021-03-11 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