Fluentd
Search…
1.0
Introduction
Overview
Installation
Configuration
Config File Syntax
Routing Examples
Config: Common Parameters
Config: Parse Section
Config: Buffer Section
Config: Format Section
Config: Extract Section
Config: Inject Section
Config: Transport Section
Config: Storage Section
Config: Service Discovery Section
Deployment
Container Deployment
Monitoring Fluentd
Input Plugins
Output Plugins
Filter Plugins
Parser Plugins
Formatter Plugins
Buffer Plugins
Storage Plugins
Service Discovery Plugins
Metrics Plugins
How-to Guides
Language Bindings
Plugin Development
Plugin Helper API
Troubleshooting Guide
Powered By GitBook
Config: Extract Section

Extract Section Overview

The extract section can be under <match>, <source>, or <filter> sections. It is enabled for the plugins that support extracting values from the event record e.g. exec.
1
<source>
2
@type exec
3
# ...
4
<extract>
5
# ...
6
</extract>
7
</source>
Copied!

Extract Section Parameter

Extract Parameters

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

Time Parameters

    time_type (enum) (optional): parses/formats 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): processes value according to the
    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 with sub-second precision, because
        ​strptime does not support
        %3N, %6N, %9N, and %L.
    localtime (bool) (optional): if true, uses local time. Otherwise,
    UTC is used. This is exclusive with utc.
      Default: true
    utc (bool) (optional): if true, uses UTC. Otherwise, local time is
    used. This is exclusive with localtime.
      Default: false
    timezone (string) (optional): uses the specified timezone. One can
    parse/format the time value in the specified timezone format.
      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)
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is an open-source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.
Previous
Config: Format Section
Next
Config: Inject Section
Last modified 4mo ago
Copy link
Contents
Extract Section Overview
Extract Section Parameter
Extract Parameters
Time Parameters