This article discusses the post-installation steps for the new Fluentd users assuming that Fluentd has been installed using the
After successful installation, a
td-agent instance will be up and running with a predefined template configuration file.
The default path for this configuration file is:
You may edit this configuration file according to your own use case.
After editing the configuration file, restart
$ sudo systemctl restart td-agent
td-agent writes its operation logs to the following file:
For more verbose logs, read the article on Troubleshooting.
In Fluentd, the most important part of data input/output is managed by plugins. Each plugin knows how to interface with an external endpoint and is solely responsible for managing one pipeline to forward data streams.
Plugins use a certain naming convention. For example, if it receives data and interfaces with Apache Kafka, it is called
in_kafka. In the same way, if it publishes data and connects to MongoDB, it is called
The following configuration uses the
in_forward plugin as an input source and
out_file plugin as an output endpoint:
<source>@type forwardport 9999</source><match app.**>@type filepath /var/log/app/data.logcompress gzip</match>
Fluentd manages plugins as Ruby gems but stores them in their dedicated directory separated from the normal Ruby gems.
A special program
td-agent-gem is used to manage plugin gems. For example, the following command installs a plugin to connect to S3 (including both
$ sudo /usr/sbin/td-agent-gem install fluent-plugin-s3
See the List Of All Plugins to explore the available third-party plugins.
Note that a number of plugins are bundled with the standard distribution of
td-agent so you do not need to install them manually.
A configuration file consists of a number of setting blocks or sections e.g.
<source>. Each block contains a set of options for a specific data endpoint.
For example, if you want to create an endpoint to receive data from syslog, you need to add a
<source> block and set up its settings like this:
<source>@type syslogport 5140tag system</source>
@type parameter specifies which plugin to use. Note that the plugin type prefix i.e.
out_, etc. is not needed here. In this example, the input plugin is specified as
To add an output endpoint for data stream, you need to define a
<match> block. Syntactically,
<match> is slightly different from
<source> in the sense that it requires a filter expression as an argument.
For example, if you want to output events tagged with
debug.log, you need to mention this tag as an argument in
<match> like this:
<match debug.log>@type kafka2port 5140brokers kafka-server:9092tag system# ...</match>
The wildcard character
* can be used in the filter expression. For example,
To catch all the descendent tags, use double asterisks
**. For example,
debug.** matches not only
debug.log, but also
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.