Skip to content

Commit 17d9778

Browse files
committed
Update README for v1
1 parent 57c767e commit 17d9778

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ Service](https://docs.aws.amazon.com/AmazonS3/latest/dev/request-rate-perf-consi
296296
You can configure the length of string with a
297297
`hex_random_length` parameter (Default: 4).
298298

299-
The default format is `%{path}%{time_slice}_%{index}.%{file_extension}`.
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.
300300

301301
For instance, using the example configuration above, actual object keys on S3
302302
will be something like:
@@ -352,7 +352,7 @@ See `Use your compression algorithm` section for adding another format.
352352
**`<format>` or format**
353353

354354
Change one line format in the S3 object. Supported formats are "out_file",
355-
"json", "ltsv" and "single_value". See also [official Formatter article](https://docs.fluentd.org/formatter).
355+
"json", "ltsv", "single_value" and other formatter plugins. See also [official Formatter article](https://docs.fluentd.org/formatter).
356356

357357
* out_file (default).
358358

@@ -372,7 +372,14 @@ information to the record by setting "include_tag_key" / "tag_key" and
372372
"include_time_key" / "time_key" option. If you set following configuration in
373373
S3 output:
374374

375-
format json
375+
# v1
376+
<format>
377+
@type json
378+
include_time_key true
379+
time_key log_time # default is time
380+
</format>
381+
# v0.12
382+
@format json
376383
include_time_key true
377384
time_key log_time # default is time
378385

@@ -430,22 +437,28 @@ uri of proxy environment.
430437

431438
**path**
432439

433-
path prefix of the files on S3. Default is "" (no prefix).
440+
path prefix of the files on S3. Default is "" (no prefix). [buffer placeholder](https://docs.fluentd.org/configuration/buffer-section#placeholders) is supported.
434441

435442
**buffer_path (required)**
436443

437444
path prefix of the files to buffer logs.
438445

446+
This parameter is for v0.12. Use `<buffer>`'s `path` in v1.
447+
439448
**time_slice_format**
440449

441450
Format of the time used as the file name. Default is '%Y%m%d'. Use
442451
'%Y%m%d%H' to split files hourly.
443452

453+
This parameter is for v0.12. Use buffer placeholder for `path` / `s3_object_key_format` in v1.
454+
444455
**time_slice_wait**
445456

446457
The time to wait old logs. Default is 10 minutes. Specify larger value if
447458
old logs may reach.
448459

460+
This parameter is for v0.12. Use `<buffer>`'s `timekey_wait` in v1.
461+
449462
**utc**
450463

451464
Use UTC instead of local time.

0 commit comments

Comments
 (0)