Versions | v0.14 (td-agent3) | v0.12 (td-agent2)

csv Formatter Plugin

The csv formatter plugin output an event as CSV.

"value1"[delimiter]"value2"[delimiter]"value3"\n

Table of Contents

Parameters

fields (Array of String, Required. defaults to “\t”(TAB))

Specify output fields

delimiter (String, Optional. defaults to “,”)

Delimiter for values.

force_quotes (Boolean, Optional, defaults to true)

If false, value won’t be framed by quotes.

add_newline (Boolean, Optional, defaults to true)

Add \n to the result.

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, Optional, 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 overwritten by the utc parameter.

timezone (String. Optional)

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.

Example

format csv
fields host,method

With this configuration:

tag:    app.event
time:   1362020400
record: {"host":"192.168.0.1","size":777,"method":"PUT"}

This incoming event is formatted to:

"192.168.0.1","PUT"\n

With force_quotes false, the result is:

192.168.0.1,PUT\n
Last updated: 2017-07-25 08:47:07 +0000

Versions | v0.14 (td-agent3) | v0.12 (td-agent2)

If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is a open source project under Cloud Native Computing Foundation (CNCF), originally invented by Treasure Data, Inc. All components are available under the Apache 2 License.

Interested in the Fluentd Newsletters?