Skip to content

Commit f4a66e6

Browse files
committed
Update README
1 parent 17d9778 commit f4a66e6

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Defaults to 'default' or `[ENV]('AWS_PROFILE')`.
165165

166166
### v1.0 style
167167

168-
With fluentd v1.0 and fluent-plugin-s3 v1.0.0, use new buffer configuration to dynamic parameters.
168+
With fluentd v1 and fluent-plugin-s3 v1.0.0 or later, use new buffer configuration to dynamic parameters.
169169

170170
<match pattern>
171171
@type s3
@@ -248,7 +248,9 @@ recommend using `s3_region` instead of `s3_endpoint`.
248248
**s3_endpoint**
249249

250250
endpoint for S3 compatible services. For example, Riak CS based storage or
251-
something. This option doesn't work on S3, use `s3_region` instead.
251+
something. This option is deprecated for AWS S3, use `s3_region` instead.
252+
253+
See also AWS article: [Working with Regions](https://aws.amazon.com/blogs/developer/working-with-regions/).
252254

253255
**enable_transfer_acceleration**
254256

@@ -296,7 +298,14 @@ Service](https://docs.aws.amazon.com/AmazonS3/latest/dev/request-rate-perf-consi
296298
You can configure the length of string with a
297299
`hex_random_length` parameter (Default: 4).
298300

299-
The default format is `%{path}%{time_slice}_%{index}.%{file_extension}`. In addition, you can use [buffer placeholders](https://docs.fluentd.org/configuration/buffer-section#placeholders) in this parameter.
301+
The default format is `%{path}%{time_slice}_%{index}.%{file_extension}`.
302+
In addition, you can use [buffer placeholders](https://docs.fluentd.org/configuration/buffer-section#placeholders) in this parameter,
303+
so you can embed tag, time and record value like below:
304+
305+
s3_object_key_format %{path}/events/%Y%m%d/${tag}_%{index}.%{file_extension}
306+
<buffer tag,time>
307+
# buffer parameters...
308+
</buffer>
300309

301310
For instance, using the example configuration above, actual object keys on S3
302311
will be something like:
@@ -437,22 +446,29 @@ uri of proxy environment.
437446

438447
**path**
439448

440-
path prefix of the files on S3. Default is "" (no prefix). [buffer placeholder](https://docs.fluentd.org/configuration/buffer-section#placeholders) is supported.
449+
path prefix of the files on S3. Default is "" (no prefix).
450+
[buffer placeholder](https://docs.fluentd.org/configuration/buffer-section#placeholders) is supported,
451+
so you can embed tag, time and record value like below.
452+
453+
path logs/%Y%m%d/${tag}/
454+
<buffer tag,time>
455+
# buffer parameters...
456+
</buffer>
441457

442-
**buffer_path (required)**
458+
**buffer_path (for v0.12)**
443459

444460
path prefix of the files to buffer logs.
445461

446462
This parameter is for v0.12. Use `<buffer>`'s `path` in v1.
447463

448-
**time_slice_format**
464+
**time_slice_format(for v0.12)**
449465

450466
Format of the time used as the file name. Default is '%Y%m%d'. Use
451467
'%Y%m%d%H' to split files hourly.
452468

453469
This parameter is for v0.12. Use buffer placeholder for `path` / `s3_object_key_format` in v1.
454470

455-
**time_slice_wait**
471+
**time_slice_wait(for v0.12)**
456472

457473
The time to wait old logs. Default is 10 minutes. Specify larger value if
458474
old logs may reach.

0 commit comments

Comments
 (0)