Skip to content

Commit

Permalink
[DOC] Clarify wording in doc descriptions (#219)
Browse files Browse the repository at this point in the history
* Clarify wording in doc descriptions

* More doc clarifications for rotation strat

* Update CHANGELOG.md
  • Loading branch information
karenzone authored Mar 11, 2020
1 parent 2efde25 commit 3b91173
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
26 changes: 20 additions & 6 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -407,8 +419,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[]
Expand Down
2 changes: 1 addition & 1 deletion logstash-output-s3.gemspec
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit 3b91173

Please sign in to comment.