Formatter Plugins

Search…

Formatter Plugins

Fluentd has nine (9) types of plugins:
​Input​
​Parser​
​Filter​
​Output​
​Formatter​
​Storage​
​Service Discovery​
​Buffer​
​Metrics​
This article gives an overview of the Formatter Plugin.
Overview
Sometimes, the output format for an output plugin does not meet one's needs. Fluentd has a pluggable system called Formatter that lets the user extend and re-use custom output formats.
How To Use
For an output plugin that supports Formatter, the <format> directive can be used to change the output format.
For example, by default, out_file plugin outputs data as
1
2014-08-25 00:00:00 +0000<TAB>foo.bar<TAB>{"k1":"v1", "k2":"v2"}
Copied!
However, if you set @type json in <format> like this:
1
<match foo.bar>
2
  @type file
3
  path /path/to/file
4
  <format>
5
    @type json
6
  </format>
7
</match>
Copied!
The output changes to
1
{"time": "2014-08-25 00:00:00 +0000", "tag":"foo.bar", "k1":"v1", "k2":"v2"}
Copied!
i.e., each line is a single JSON object with "time" and "tag fields to retain the event's timestamp and tag.
See this section to learn how to develop a custom formatter.
List of Built-in Formatters
​out_file​
​json​
​ltsv​
​csv​
​msgpack​
​hash​
​single_value​
​tsv​
List of Output/Filter Plugins with Formatter Support
​filter_stdout​
​out_file​
​out_s3​
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.

none

out_file

Last modified 1mo ago

Copy link

Contents

Overview

How To Use

List of Built-in Formatters

List of Output/Filter Plugins with Formatter Support