Versions | v1.0 (td-agent3)

Inject section configurations

Table of Contents

Inject section overview

Inject section can be in <match> or <filter> sections. It’s enabled for plugins which support injecting values to the event record.

<match>
  @type file
  # parameters for output plugin
  <inject>
    # inject section parameters
  </inject>
</match>

Example

Here is an example of configuration and event:

# Configuration example
<inject>
  time_key fluentd_time
  time_type string
  time_format %Y-%m-%dT%H:%M:%S.%NZ
  tag_key fluentd_tag
</inject>

# Record example
tag: test
time: 1547575563.952259
record: {"message":"hello"}

Injected record is below:

{"message":"hello","fluetnd_tag":"test","fluentd_time":"2019-01-15T18:06:03.952259000Z"}

inject section parameter

Inject parameters

  • hostname_key (string) (optional): the field name to inject hostname
    • Default: nil
  • hostname (string) (optional): hostname value
    • Default: Socket.gethostname
  • worker_id_key (string) (optional): the field name to inject worker_id
    • Default: nil
  • tag_key (string) (optional): the field name to inject tag
    • Default: nil
  • time_key (string) (optional): the field name to inject time
    • Default: nil

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)
        • Use %N to parse/format subsecond, because strptime does not support %3N, %6N, %9N, and %L
  • 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: 2019-04-22 00:22:56 +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.