Install by DEB Package (Debian/Ubuntu)
This article explains how to install stable versions of fluent-package
deb packages, the stable Fluentd distribution packages maintained by Fluentd Project and calyptia-fluentd
which is maintained by Calyptia, Inc..
What is fluent-package
?
fluent-package
?Fluentd is written in Ruby for flexibility, with performance-sensitive parts in C. However, some users may have difficulty installing and operating a Ruby daemon.
That is why Fluentd Project provides the stable distribution of Fluentd, called fluent-package
(formerly known as td-agent
). The differences between Fluentd and fluent-package
can be found here.
What is calyptia-fluentd
?
calyptia-fluentd
?Our Calyptia also knows that Fluentd is written in Ruby for flexibility, with performance-sensitive parts in C. However, some users may have difficulty installing and operating a Ruby daemon. And td-agent
is still seated on Ruby 2.7 due to compatibility reasons and Ruby versioning policy, calyptia-fluentd
uses Ruby 3 instead of Ruby 2.7 for now.
That is why Calyptia, Inc. provides the alternative stable distribution of Fluentd, called calyptia-fluentd
. The differences between td-agent
and calyptia-fluentd
are bundled and running Ruby versions for now.
This installation guide is for fluent-package
v5 and calyptia-fluentd
v1. fluent-package
v5 and calyptia-fluentd
use fluentd v1 in the core. See fluent-package-v5-vs-td-agent or td-agent-v2-vs-v3-vs-v4 for the comparison and supported OS.
Installing fluent-package
fluent-package
NOTE:
About deprecated Treasure Agent (td-agent) v4 (EOL), See Install by DEB Package v4.
About deprecated Treasure Agent (td-agent) 3 will not be maintained anymore, see Install by DEB Package v3.
fluent-package
will be shipped in two flavors - normal release version and LTS (Long Term Support) version. See Scheduled support lifecycle announcement about Fluent Package about difference between this two flavors.If you upgrade from
td-agent
v4, See Upgrade to fluent-package v5.Do not directly upgrade from v3 to v5. Such a workflow is not supported. It causes a trouble. Upgrade in stages. (v3 to v4, then v4 to v5)
Step 0: Before Installation
Please follow the Pre-installation Guide to configure your OS properly.
Step 1: Install from Apt Repository
NOTE: If your OS is not supported, consider gem installation instead.
A shell script is provided to automate the installation process for each version. The shell script registers a new apt repository at /etc/apt/sources.list.d/fluent.sources
(or /etc/apt/sources.list.d/fluent-lts.sources
) and installs the fluent-package
deb package.
For Ubuntu Noble:
fluent-package 5 (LTS)
fluent-package 5
For Ubuntu Jammy:
fluent-package 5 (LTS)
fluent-package 5
For Ubuntu Focal:
fluent-package 5 (LTS)
fluent-package 5
For Debian Bookworm:
fluent-package 5 (LTS)
fluent-package 5
For Debian Bullseye:
fluent-package 5 (LTS)
fluent-package 5
Step 2: Launch Daemon
systemd
systemd
Use /lib/systemd/system/fluentd
script to start
, stop
, or restart
the agent:
To customize systemd
behavior, put your fluentd.service
in /etc/systemd/system
.
NOTE: In fluent-package v5, path is different. /opt/fluent/bin
instead of /opt/td-agent/bin
Step 3: Post Sample Logs via HTTP
The default configuration (/etc/fluent/fluentd.conf
) is to receive logs at an HTTP endpoint and route them to stdout
. For fluent-package
logs, see /var/log/fluent/fluentd.log
.
You can post sample log records with curl
command:
Using to install calyptia-fluentd
calyptia-fluentd
Step 0: Before Installation
Please follow the Pre-installation Guide to configure your OS properly.
Step 1: Install from Apt Repository
NOTE: If your OS is not supported, consider gem installation instead.
A shell script is provided to automate the installation process for each version. The shell script registers a new apt repository at /etc/apt/sources.list.d/calyptia-fluentd.sources
and installs the calyptia-fluentd
deb package.
For Ubuntu Focal:
For Ubuntu Bionic:
For Ubuntu Xenial:
For Debian Buster:
Step 2: Launch Daemon
systemd
systemd
Use /lib/systemd/system/calyptia-fluentd
script to start
, stop
, or restart
the agent:
To customize systemd
behavior, put your calyptia-fluentd.service
in /lib/systemd/system
.
Please make sure your configuration file path is:
Step 3: Post Sample Logs via HTTP
The default configuration (/etc/calyptia-fluentd/calyptia-fluentd.conf
) is to receive logs at an HTTP endpoint and route them to stdout
. For calyptia-fluentd
logs, see /var/log/calyptia-fluentd/calyptia-fluentd.log
.
You can post sample log records with curl
command:
Next Steps
You are now ready to collect real logs with Fluentd. Refer to the following tutorials on how to collect data from various sources:
Basic Configuration
For further steps, follow these:
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.
Last updated