logstash-output-s3
logstash-output-s3 copied to clipboard
Documentation issue with required parameters 'size_file' or 'time_file'
Docs report that time_file
and size_file
are optional, but you need to at least set one of those to make this work:
output {
s3{
access_key_id => "crazy_key" (required)
secret_access_key => "monkey_access_key" (required)
endpoint_region => "eu-west-1" (required)
bucket => "boss_please_open_your_bucket" (required)
size_file => 2048 (optional)
time_file => 5 (optional)
format => "plain" (optional)
canned_acl => "private" (optional. Options are "private", "public_read", "public_read_write", "authenticated_read". Defaults to "private" )
}
CC @palecur @debadair
I suggest we do this:
- Set a default value to
size_file
to 1024 - Set a default value to
time_file
to 10 minutes - Add a validation to make sure both of theses values arent 0.
Also update this part of the doc:
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.
Also clarify the docs to explain what the file will look like on the bucket. Chunks/part etc.
Following the comment from @gmoskovicz
looks like this will upload the entire file, but it actually creates chunks of the file and it sends it periodically (depending on the size or the refresh rate)
SGTM! @ph :+1:
@ph +1 your suggestion
+1
@ph This can be closed, correct? The code now specifies defaults as you suggested, and a proper exception is raised if both size_file
and time_file
are set to 0.