Versions | v1.0 (td-agent3)

Extract section configurations

Table of Contents

Extract section overview

Extract section can be in <match>, <source>, or <filter> sections. It’s enabled for plugins which support extracting values from the event record.

<source>
  @type exec
  # parameters for input plugin
  <extract>
    # extract section parameters
  </extract>
</source>

extract section parameter

Extract parameters

  • tag_key (string) (optional): the field name to extract tag
    • Default: nil
  • keep_tag_key (bool) (optional): if true keep the field in the record after extract value
    • Default: false
  • time_key (string) (optional): the field name to extract time
    • Default: nil
  • keep_time_key (bool) (optional): if true keep the field in the record after extract value
    • Default: false

Time parameters

  • time_type (enum) (optional): parse/format value according to this type
    • Default: float
    • Available values: float, unixtime, string
      • float: seconds from Epoch + nano seconds (e.g. 1510544836.154709804)
      • unixtime: seconds from Epoch (e.g. 1510544815)
      • string: use format specified by time_format, local time or time zone
  • time_format (string) (optional): process value using specified format. This is available only when time_type is string
    • Default: nil
    • Available time format:
      • For more details about formatting, see Time#strftime
      • For more details about parsing, see Time.strptime
      • %iso8601 (only for parsing)
  • localtime (bool) (optional): if true, use local time. Otherwise, UTC is used. This is exclusive with utc.
    • Default: true
  • utc (bool) (optional): if true, use UTC. Otherwise, local time is used. This is exclusive with localtime.
    • Default: false
  • timezone (string) (optional): use specified timezone. one can parse/format the time value in the specified timezone.
    • Default: nil
    • Available time zone format:
      1. [+-]HH:MM (e.g. “+09:00”) (recommended)
      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”)
Last updated: 2018-08-20 21:55:38 +0000

Versions | v1.0 (td-agent3)

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). All components are available under the Apache 2 License.