[Doc]Add example for exclude pattern (#204)

* Add example for exclude pattern * Bump to v3.5.1 * Update docs/index.asciidoc Co-Authored-By: Ry Biesemeyer <[email protected]> * Minor edits * Add new line Co-authored-by: Ry Biesemeyer <[email protected]>
logstash-plugins · Apr 16, 2020 · 01d9287 · 01d9287
1 parent 16b4e38
commit 01d9287
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 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)

diff --git a/docs/index.asciidoc b/docs/index.asciidoc
@@ -80,6 +80,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` 
 
@@ -157,7 +180,20 @@ 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
+Ruby style regexp of keys to exclude from the bucket.
+
+Note that files matching the pattern are skipped _after_ they have been listed. 
+Consider using <<plugins-{type}s-{plugin}-prefix>> instead where possible.
+
+Example:
+
+[source,ruby]
+-----
+"exclude_pattern" => "\/2020\/04\/"
+-----
+
+This pattern excludes all logs containing "/2020/04/" in the path.
+
 
 [id="plugins-{type}s-{plugin}-gzip_pattern"]
 ===== `gzip_pattern`
@@ -167,28 +203,6 @@ Ruby style regexp of keys to exclude from the bucket
 
 Regular expression used to determine whether an input file is in gzip format.
 
-[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}-include_object_properties"]
 ===== `include_object_properties`
 

diff --git a/logstash-input-s3.gemspec b/logstash-input-s3.gemspec
@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-s3'
-  s.version         = '3.5.0'
+  s.version         = '3.5.1'
   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"