logstash-output-s3 4.3.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9a7a272abc73ba56936d68d273ec4042421d0082fc3e92e5e27dda3e93af21
-  data.tar.gz: 2a583ab3d5d69aef1ce03c98ec24e5f621d64e56517ed552fdc0495adecee24b
+  metadata.gz: 77a8b277837b6c5cf66c29910d6861ae96e5f20615a77a4df77cbfb12d72bd17
+  data.tar.gz: 54925f9dc7d8e1657e0dc30b8513c4cecef036287505883207eafe645755e350
 SHA512:
-  metadata.gz: dcae487d4c4a129aa7d7c53883f680807b2bbcf472566099fbca39316a685e9ae965aecb1f880f60227815097b13f1a773f0a1bd6d1f89bd236c809502141a6f
-  data.tar.gz: 9bac6b7e4bad12b8d3766dbf82ab6f8f1cbd3a366dee87b93ab12df21f380b458d233f4dbc87dae3cd787f5cb968468eea004389eee36ffb0d8806ab70fe36c5
+  metadata.gz: cafe916fa41c47f79ebc814d7decd7e809b006d930df73daed88bb56b346e693376f3f2b1987e53402481ab940851757da062d54036862ae68b83386f5076d64
+  data.tar.gz: 5c9733afe95a7538ab55b0bd70ca13811eac461a90b06d9167538f8805647f27945404867c4abe901d9943d1dac7bc2041943e7fec77495ba2741412f2bec570

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.3.1
+  -  [DOC] Updated setting descriptions for clarity [#219](https://github.com/logstash-plugins/logstash-output-s3/pull/219)and [#220](https://github.com/logstash-plugins/logstash-output-s3/pull/220)
+
 ## 4.3.0
   -  Feat: Added retry_count and retry_delay config [#218](https://github.com/logstash-plugins/logstash-output-s3/pull/218)
 

data/docs/index.asciidoc

@@ -283,8 +283,19 @@ Session name to use when assuming an IAM role.
   * Value can be any of: `size_and_time`, `size`, `time`
   * Default value is `"size_and_time"`
 
-Define the strategy to use to decide when we need to rotate the file and push it to S3,
-The default strategy is to check for both size and time, the first one to match will rotate the file.
+Controls when to close the file and push it to S3. 
+
+If you set this value to `size`, it uses the value set in
+<<plugins-{type}s-{plugin}-size_file,`size_file`>>.
+If you set this value to `time`, it uses the value set in
+<<plugins-{type}s-{plugin}-time_file,`time_file`>>.
+If you set this value to `size_and_time`, it uses the values from
+<<plugins-{type}s-{plugin}-size_file,`size_file`>> and
+<<plugins-{type}s-{plugin}-time_file,`time_file`>>, and splits the file when
+either one matches. 
+
+The default strategy checks both size and time. The first value to
+match triggers file rotation.
 
 [id="plugins-{type}s-{plugin}-secret_access_key"]
 ===== `secret_access_key` 
@@ -333,8 +344,9 @@ specified here
   * Value type is <<number,number>>
   * Default value is `5242880`
 
-Set the size of file in bytes, this means that files on bucket when dimension > file_size, are stored in two or more files.
-If you have tags then it will generate a specific size file for every tags
+Set the file size in bytes. When the number of bytes exceeds the `size_file`
+value, a new file is created. If you use tags, Logstash generates a specific size
+file for every tag.
 
 [id="plugins-{type}s-{plugin}-ssekms_key_id"]
 ===== `ssekms_key_id` 
@@ -373,9 +385,8 @@ default to the current OS temporary directory in linux /tmp/logstash
   * Default value is `15`
 
 Set the time, in MINUTES, to close the current sub_time_section of bucket.
-If you define file_size you have a number of files in consideration of the section and the current tag.
-0 stay all time on listener, beware if you specific 0 and size_file 0, because you will not put the file on bucket,
-for now the only thing this plugin can do is to put the file when logstash restart.
+If <<plugins-{type}s-{plugin}-rotation_strategy,`rotation_strategy`>> is set to `time` or `size_and_time`, then `time_file` cannot be set to 0. 
+Otherwise, the plugin raises a configuration error.
 
 [id="plugins-{type}s-{plugin}-upload_multipart_threshold"]
 ===== `upload_multipart_threshold`
@@ -407,8 +418,10 @@ Specify how many workers to use to upload the files to S3
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-The common use case is to define permission on the root bucket and give Logstash full access to write its logs.
-In some circumstances you need finer grained permission on subfolder, this allows you to disable the check at startup.
+The common use case is to define permissions on the root bucket and give Logstash
+full access to write logs. 
+In some circumstances, you need more granular permissions on the subfolder. This
+allows you to disable the check at startup.
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/s3.rb

@@ -114,9 +114,8 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
   config :size_file, :validate => :number, :default => 1024 * 1024 * 5
 
   # Set the time, in MINUTES, to close the current sub_time_section of bucket.
-  # If you define file_size you have a number of files in consideration of the section and the current tag.
-  # 0 stay all time on listerner, beware if you specific 0 and size_file 0, because you will not put the file on bucket,
-  # for now the only thing this plugin can do is to put the file when logstash restart.
+  # If you also define file_size you have a number of files related to the section and the current tag.
+  # If it's valued 0 and rotation_strategy is 'time' or 'size_and_time' then the plugin reaise a configuration error.
   config :time_file, :validate => :number, :default => 15
 
   ## IMPORTANT: if you use multiple instance of s3, you should specify on one of them the "restore=> true" and on the others "restore => false".

data/logstash-output-s3.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-s3'
-  s.version         = '4.3.0'
+  s.version         = '4.3.1'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Sends Logstash events to the Amazon Simple Storage Service"
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-s3
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement