logstash-output-s3 4.1.8 → 4.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4cf264de35b436280daac5ccab48529f9f3e8037a37c40f634e479c49dd0b3e
-  data.tar.gz: 6c5fe67b82ea4dc36a471ad06199fb241a171bb4142ef754da2436211d99d4b6
+  metadata.gz: 7653884bdf554ea5da088fff8ccedf6e4371d55bab768276f887043fc1951d61
+  data.tar.gz: b972c14f15fef7b7b088db17d521c1255832280b005e35060948ee27c98b0b2e
 SHA512:
-  metadata.gz: f1afe8b78490ae972d08216adf887447ada0fef5adb3c67badb8243b84b907d35da6bebc0dbd354dae10f3adb0f1840a996192eac43482725a58eb70fa55eb0e
-  data.tar.gz: 611ef2103780b7ef705dace7e1bd95e5c931c4f4276cf3db22c648acf555667f5eb88c43856014d6e7a093f9ea22c50731955ade23a779d85a0d9088085e9e33
+  metadata.gz: de5e04e1f51a90c62b14992a4aba4fc2f05ba7be30ea697bbd21747a376d13a5dd9a4e6dc773cc727f773f16541ba35a58fb3ab1147e37e0e757cdb8487eef13
+  data.tar.gz: 77e29b0995184da283de1ea27122ab6ac343e22a337a35c617cbd1005657c44ef00616a7687672f543e799f89911ecf03a651d8184d5988ea7fa2d1680686b2f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.1.9
+  - Added configuration information for multiple s3 outputs to documentation [#196](https://github.com/logstash-plugins/logstash-output-s3/pull/196)
+  - Fixed formatting problems and typographical errors [#194](https://github.com/logstash-plugins/logstash-output-s3/pull/194), [#201](https://github.com/logstash-plugins/logstash-output-s3/pull/201), and [#204](https://github.com/logstash-plugins/logstash-output-s3/pull/204)
+
 ## 4.1.8
   - Add support for setting mutipart upload threshold [#202](https://github.com/logstash-plugins/logstash-output-s3/pull/202)
 

data/docs/index.asciidoc

@@ -21,39 +21,41 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-INFORMATION:
-
 This plugin batches and uploads logstash events into Amazon Simple Storage Service (Amazon S3).
 
-Requirements:
-* Amazon S3 Bucket and S3 Access Permissions (Typically access_key_id and secret_access_key)
-* S3 PutObject permission
+S3 outputs create temporary files into the OS' temporary directory. 
+You can specify where to save them using the `temporary_directory` option.
 
-S3 outputs create temporary files into the OS' temporary directory, you can specify where to save them using the `temporary_directory` option.
+IMPORTANT: For configurations containing multiple s3 outputs with the restore
+option enabled, each output should define its own 'temporary_directory'.
 
-S3 output files have the following format
+===== Requirements
 
-ls.s3.312bc026-2f5d-49bc-ae9f-5940cf4ad9a6.2013-04-18T10.00.tag_hello.part0.txt
+* Amazon S3 Bucket and S3 Access Permissions (Typically access_key_id and secret_access_key)
+* S3 PutObject permission
 
+===== S3 output file
+ 
+[source,txt]
+-----
+`ls.s3.312bc026-2f5d-49bc-ae9f-5940cf4ad9a6.2013-04-18T10.00.tag_hello.part0.txt`
+-----
 
 |=======
-| ls.s3 | indicate logstash plugin s3 |
+| ls.s3 | indicates logstash plugin s3 |
 | 312bc026-2f5d-49bc-ae9f-5940cf4ad9a6 | a new, random uuid per file. |
 | 2013-04-18T10.00 | represents the time whenever you specify time_file. |
-| tag_hello | this indicates the event's tag. |
-| part0 | this means if you indicate size_file then it will generate more parts if your file.size > size_file. When a file is full it will be pushed to the bucket and then deleted from the temporary directory. If a file is empty, it is simply deleted.  Empty files will not be pushed |
+| tag_hello | indicates the event's tag. |
+| part0 | If you indicate size_file, it will generate more parts if your file.size > size_file. 
+When a file is full, it gets pushed to the bucket and then deleted from the temporary directory. 
+If a file is empty, it is simply deleted.  Empty files will not be pushed. |
 |=======
 
-Crash Recovery:
-* This plugin will recover and upload temporary log files after crash/abnormal termination when using `restore` set to true
-
-
+===== Crash Recovery
 
+This plugin will recover and upload temporary log files after crash/abnormal termination when using `restore` set to true
 
-
-
-
-#### Usage:
+===== Usage
 This is an example of logstash config:
 [source,ruby]
 output {
@@ -120,11 +122,11 @@ output plugins.
 
 This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
 
-1. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config
-2. External credentials file specified by `aws_credentials_file`
-3. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
-4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
-5. IAM Instance Profile (available when running inside EC2)
+. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config
+. External credentials file specified by `aws_credentials_file`
+. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
+. IAM Instance Profile (available when running inside EC2)
 
 [id="plugins-{type}s-{plugin}-additional_settings"]
 ===== `additional_settings`
@@ -211,7 +213,7 @@ guaranteed to work correctly with the AWS SDK.
 Specify a prefix to the uploaded filename, this can simulate directories on S3.  Prefix does not require leading slash.
 This option supports logstash interpolation: https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#sprintf;
 for example, files can be prefixed with the event date using `prefix = "%{+YYYY}/%{+MM}/%{+dd}"`.
-Be warned this can created a lot of temporary local files.
+Be warned this can create a lot of temporary local files.
 
 [id="plugins-{type}s-{plugin}-proxy_uri"]
 ===== `proxy_uri` 
@@ -235,6 +237,9 @@ The AWS Region
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
+Used to enable recovery after crash/abnormal termination.
+Temporary log files will be recovered and uploaded.
+
 [id="plugins-{type}s-{plugin}-role_arn"]
 ===== `role_arn`
 
@@ -350,7 +355,7 @@ default to the current OS temporary directory in linux /tmp/logstash
 
 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,
+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.
 
 [id="plugins-{type}s-{plugin}-upload_multipart_threshold"]
@@ -384,9 +389,7 @@ Specify how many workers to use to upload the files to S3
   * 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 circonstances you need finer grained permission on subfolder, this allow you to disable the check at startup.
-
-
+In some circumstances you need finer grained permission on subfolder, this allow you to disable the check at startup.
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

data/logstash-output-s3.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-s3'
-  s.version         = '4.1.8'
+  s.version         = '4.1.9'
   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.1.8
+  version: 4.1.9
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement