Available languages | en | ja |

Amazon S3 Output Plugin

The out_s3 TimeSliced Output plugin writes records into the Amazon S3 cloud object storage service. By default, it creates files on an hourly basis. This means that when you first import records using the plugin, no file is created immediately. The file will be created when the time_slice_format condition has been met. To change the output frequency, please modify the time_slice_format value.

Table of Contents

Installation

out_s3 is included in td-agent by default. Fluentd gem users will need to install the fluent-plugin-s3 gem using the following command.

$ fluent-gem install fluent-plugin-s3

Example Configuration

<match pattern>
  type s3

  aws_key_id YOUR_AWS_KEY_ID
  aws_sec_key YOUR_AWS_SECRET/KEY
  s3_bucket YOUR_S3_BUCKET_NAME
  s3_endpoint s3-us-west-1.amazonaws.com
  path logs/
  buffer_path /var/log/fluent/s3

  time_slice_format %Y%m%d%H
  time_slice_wait 10m
  utc

  buffer_chunk_limit 256m
</match>

Please see the Store Apache Logs into Amazon S3 article for real-world use cases.

Please see the Config File article for the basic structure and syntax of the configuration file.
Please make sure that you have enough space in the buffer_path directory. Running out of disk space is a problem frequently reported by users.

Parameters

type (required)

The value must be s3.

aws_key_id (required/optional)

The AWS access key id. This parameter is required when your agent is not running on an EC2 instance with an IAM Instance Profile.

aws_sec_key (required/optional)

The AWS secret key. This parameter is required when your agent is not running on an EC2 instance with an IAM Instance Profile.

s3_bucket (required)

The Amazon S3 bucket name.

buffer_path (required)

The path prefix of the log buffer files.

s3_endpoint

The Amazon S3 endpoint name. Please select the appropriate endpoint name from the list below and confirm that your bucket has been created in the correct region.

  • s3.amazonaws.com
  • s3-us-west-1.amazonaws.com
  • s3-us-west-2.amazonaws.com
  • s3.sa-east-1.amazonaws.com
  • s3-eu-west-1.amazonaws.com
  • s3-ap-southeast-1.amazonaws.com
  • s3-ap-northeast-1.amazonaws.com

The most recent versions of the endpoints can be found here.

format

The format of the S3 object. The default is out_file.

out_file

Output time, tag and json record separated by a delimiter:

time[delimiter]tag[delimiter]record\n

Example:

2014-06-08T23:59:40[TAB]file.server.logs[TAB]{"field1":"value1","field2":"value2"}\n

out_file format has several options to customize the format.

delimiter SPACE   # Optional, SPACE or COMMA. "\t"(TAB) is used by default
output_tag false  # Optional, defaults to true. Output the tag field if true.
output_time true  # Optional, defaults to true. OUtput the time field if true.

For this format, the following common parameters are also supported.

  • include_time_key (Boolean, Optional, defaults to false) If true, the time field (as specified by the time_key parameter) is kept in the record.
  • time_key (String, xOptional, defaults to “time”) The field name for the time key.
  • time_format (String. Optional) By default, the output format is iso8601 (e.g. “2008-02-01T21:41:49”). One can specify their own format with this parameter.
  • include_tag_key (Boolean. Optional, defaults to false) If true, the tag field (as specified by the tag_key parameter) is kept in the record.
  • tag_key (String, Optional, defaults to “tag”) The field name for the tag key.
  • localtime (Boolean. Optional, defaults to true) If true, use local time. Otherwise, UTC is used. This parameter is overwridden by the utc parameter.
  • timezone (String. Optional. v0.10.56 and above) By setting this parameter, one can parse the time value in the specified timezone. The following formats are accepted:

    1. [+–]HH:MM (e.g. “+09:00”)
    2. [+–]HHMM (e.g. “+0900”)
    3. [+–]HH (e.g. “+09”)
    4. Region/Zone (e.g. “Asia/Tokyo”)
    5. Region/Zone/Zone (e.g. “America/Argentina/Buenos_Aires”)

    The timezone set in this parameter takes precedence over localtime, e.g., if localtime is set to true but timezone is set to +0000, UTC would be used.

json

Output a json record without the time or tag field:

{"field1":"value1","field2":"value2"}\n

For this format, the following common parameters are also supported.

  • include_time_key (Boolean, Optional, defaults to false) If true, the time field (as specified by the time_key parameter) is kept in the record.
  • time_key (String, xOptional, defaults to “time”) The field name for the time key.
  • time_format (String. Optional) By default, the output format is iso8601 (e.g. “2008-02-01T21:41:49”). One can specify their own format with this parameter.
  • include_tag_key (Boolean. Optional, defaults to false) If true, the tag field (as specified by the tag_key parameter) is kept in the record.
  • tag_key (String, Optional, defaults to “tag”) The field name for the tag key.
  • localtime (Boolean. Optional, defaults to true) If true, use local time. Otherwise, UTC is used. This parameter is overwridden by the utc parameter.
  • timezone (String. Optional. v0.10.56 and above) By setting this parameter, one can parse the time value in the specified timezone. The following formats are accepted:

    1. [+–]HH:MM (e.g. “+09:00”)
    2. [+–]HHMM (e.g. “+0900”)
    3. [+–]HH (e.g. “+09”)
    4. Region/Zone (e.g. “Asia/Tokyo”)
    5. Region/Zone/Zone (e.g. “America/Argentina/Buenos_Aires”)

    The timezone set in this parameter takes precedence over localtime, e.g., if localtime is set to true but timezone is set to +0000, UTC would be used.

ltsv

Output the record as LTSV:

field1[label_delimiter]value1[delimiter]field2[label_delimiter]value2\n

ltsv format supports delimiter and label_delimiter options.

format ltsv
delimiter SPACE   # Optional. "\t"(TAB) is used by default
label_delimiter = # Optional. ":" is used by default

For this format, the following common parameters are also supported.

  • include_time_key (Boolean, Optional, defaults to false) If true, the time field (as specified by the time_key parameter) is kept in the record.
  • time_key (String, xOptional, defaults to “time”) The field name for the time key.
  • time_format (String. Optional) By default, the output format is iso8601 (e.g. “2008-02-01T21:41:49”). One can specify their own format with this parameter.
  • include_tag_key (Boolean. Optional, defaults to false) If true, the tag field (as specified by the tag_key parameter) is kept in the record.
  • tag_key (String, Optional, defaults to “tag”) The field name for the tag key.
  • localtime (Boolean. Optional, defaults to true) If true, use local time. Otherwise, UTC is used. This parameter is overwridden by the utc parameter.
  • timezone (String. Optional. v0.10.56 and above) By setting this parameter, one can parse the time value in the specified timezone. The following formats are accepted:

    1. [+–]HH:MM (e.g. “+09:00”)
    2. [+–]HHMM (e.g. “+0900”)
    3. [+–]HH (e.g. “+09”)
    4. Region/Zone (e.g. “Asia/Tokyo”)
    5. Region/Zone/Zone (e.g. “America/Argentina/Buenos_Aires”)

    The timezone set in this parameter takes precedence over localtime, e.g., if localtime is set to true but timezone is set to +0000, UTC would be used.

single_value

Output the value of a single field instead of the whole record. Often used in conjunction with in_tail’s format none.

value1\n

single_value format supports the add_newline and message_key options.

add_newline false # Optional, defaults to true. If there is a trailing "\n" already, set it "false"
message_key my_field # Optional, defaults to "message". The value of this field is outputted.

time_slice_format

The time format used as part of the file name. The following characters are replaced with actual values when the file is created:

  • %Y: year including the century (at least 4 digits)
  • %m: month of the year (01..12)
  • %d: Day of the month (01..31)
  • %H: Hour of the day, 24-hour clock (00..23)
  • %M: Minute of the hour (00..59)
  • %S: Second of the minute (00..60)

The default format is %Y%m%d%H, which creates one file per hour.

time_slice_wait

The amount of time Fluentd will wait for old logs to arrive. This is used to account for delays in logs arriving to your Fluentd node. The default wait time is 10 minutes (‘10m’), where Fluentd will wait until 10 minutes past the hour for any logs that occured within the past hour.

For example, when splitting files on an hourly basis, a log recorded at 1:59 but arriving at the Fluentd node between 2:00 and 2:10 will be uploaded together with all the other logs from 1:00 to 1:59 in one transaction, avoiding extra overhead. Larger values can be set as needed.

time_format

The format of the time written in files. The default format is ISO-8601.

path

The path prefix of the files on S3. The default is “” (no prefix).

The actual path on S3 will be: “{path}{time_slice_format}_{sequential_index}.gz” (see `s3_object_key_format`)

s3_object_key_format

The actual S3 path. The default value is %{path}%{time_slice}_%{index}.%{file_extension}, which is interpolated to the actual path (ex: Ruby’s variable interpolation).

  • path: the value of the path parameter above
  • time_slice: the time string as formatted by time_slice_format
  • index: the index for the given path. Incremented per buffer flush
  • file_extension: as determined by the store_as parameter.

For example, if

  • s3_object_key_format is as default
  • path is “hello”
  • time_slice_format is “%Y%m%d”
  • store_as is “json”

Then, “hello20141111_0.json” would be an example actual S3 path.

This parameter is for advanced users. Most users should NOT modify it. Also, always make sure that %{index} appears in the customized `s3_object_key_format` (Otherwise, multiple buffer flushes within the same time slice throws an error).

utc

Uses UTC for path formatting. The default format is localtime.

store_as

The compression type. The default is “gzip”, but you can also choose “lzo”, “json”, or “txt”.

proxy_uri

The proxy url. The default is nil.

use_ssl

Enable/disable SSL for data transfers between Fluentd and S3. The default is “yes”.

Buffer Parameters

For advanced usage, you can tune Fluentd’s internal buffering mechanism with these parameters.

buffer_type

The buffer type is file by default (buf_file). The memory (buf_memory) buffer type can be chosen as well. If you use file buffer type, buffer_path parameter is required.

buffer_queue_limit, buffer_chunk_limit

The length of the chunk queue and the size of each chunk, respectively. Please see the Buffer Plugin Overview article for the basic buffer structure. The default values are 64 and 8m, respectively. The suffixes “k” (KB), “m” (MB), and “g” (GB) can be used for buffer_chunk_limit.

flush_interval

The interval between data flushes. The default is 60s. The suffixes “s” (seconds), “m” (minutes), and “h” (hours) can be used.

retry_wait, max_retry_wait

The initial and maximum intervals between write retries. The default values are 1.0 and unset (no limit). The interval doubles (with +/-12.5% randomness) every retry until max_retry_wait is reached. In the default configuration the last retry waits for approximately 131072 sec, roughly 36 hours.

retry_limit, disable_retry_limit

The limit on the number of retries before buffered data is discarded, and an option to disable that limit (if true, the value of retry_limit is ignored and there is no limit). The default values are 17 and false (not disabled). If the limit is reached, buffered data is discarded and the retry interval is reset to its initial value (retry_wait).

disable_retry_limit is available for v0.10.53 and above.

num_threads

The number of threads to flush the buffer. This option can be used to parallelize writes into the output(s) designated by the output plugin. The default is 1.

log_level option (Fluentd v0.10.43 and above)

The log_level option allows the user to set different levels of logging for each plugin. The supported log levels are: fatal, error, warn, info, debug, and trace.

Please see the logging article for further details.

Further Reading

This page doesn’t describe all the possible configurations. If you want to know about other configurations, please check the link below.

Last updated: 2014-11-16 18:39:43 UTC

Available languages | en | ja |

If this article is incorrect or outdated, or omits critical information, please let us know.

Interested in the Fluentd Newsletters?