Hi users and developers!
We announce the dropping schedule for TD Agent 4 development.
Since td-agent 4.0.0 was released in 2020, td-agent 4 has been maintained for a long time.
As new major version of td-agent 4 was rebranded (to fluent-package
v5), and released in August 2023,
we decided to stop maintaining td-agent 4.
As you know, already stepping down maintenance activity, new minor update for td-agent 4 will not be shipped anymore. (td-agent v4.5.1 will be the last release of this series, it will be shipped in this month.)
Thus, we recommend using fluent-package v5 for new deployment :)
There is a good article to do it.
Follow the above instructions.
Hi users!
We have released fluent-package
v5.0.0 (Release Candidate) and
the following v5.0.1 (General Availability).
fluent-package is formerly known as td-agent
and a stable distribution package of Fluentd.
In this blog article, we explains why the concept of channels is introduced.
In the previous versions, td-agent
was shipped as quarterly releases in most cases.
It sometimes contains fluentd minor upgrade occasionally, which means that not only bug or security fixes,
but also contains new features. As a result, there was a case that the stability was affected unexpectedly.
In point view of adopting fluentd (and td-agent
) for enterprise services, there was a requirement for the distribution which contains security or bug fixes only
and scheduled lifecycle of it.
The LTS release is the answer to support them.
There are two channels of support lifecycle.
Here is the difference of these channels.
fluent-package
v6.0.0, and will be shipped in 2025.As for fluent-package v5,
Current releases and future plans:
Release Version | Release Date | End of life |
---|---|---|
v4.5.1 | Aug, 2023 | Dec, 2023 |
v5.0.1 (LTS) | Aug 29, 2023 | March, 2025 |
v6.0.0 (LTS) | March, 2025? (T.B.D.) | T.B.D. |
Happy logging!
fluent-package
"v5" is available since August 2023.
fluent-package
is the successor of td-agent
"v4".
In this post, we will share the steps we've tested and hopefully this will help your experience from v4 to v5.
fluent-package
was formerly known as td-agent
.
In the past, Treasure Data, Inc took the initiative to provide the package, but now the Fluentd community does it. This is why the package name was changed.
To represent "All in one package of Fluentd which contains Fluentd and related gem packages", the package name was changed to fluent-package
.
Even though package name was changed, Treasure Data, Inc still sponsor the package delivery resources.
There are two channels for fluent-package
.
One is normal release version which will be updated regularly - rapid release development style (td-agent v4
was released like this in almost every quarter).
In this version, fluentd will be eventually updated to newer minor version (e.g. 1.17.x and so on)
The other is a more conservative maintenance version (Long Term Support) which will not introduce a new feature. It only applies teeny update such as security or bug fix only. LTS for v5 will be supported until March, 2025.
More details about difference between normal release version and LTS version will be explained in Scheduled support lifecycle announcement about Fluent Package.
In the fluent-package
v5, core components like ruby (2.7.8 -> 3.2.2) and OpenSSL (1.1.1 -> 3.1.0 for Windows, 3.0.8 for macOS) were updated.
The major changes are as follows.
td-agent
command is renamed to fluentd
.
$ td-agent --version
-> $ fluentd --version
td-agent-gem
command is renamed to fluent-gem
.
$ td-agent-gem list
-> $ fluent-gem list
td-agent
is renamed to fluentd
.
$ systemctl status td-agent
-> $ systemctl status fluentd
With the change of package name, install path, service name (e.g. /opt/fluent, fluentd.service) and so on were also changed.
Basically, for td-agent
v4 users, it aims to keep compatibility as far as possible by executing the migration process with copying old files or providing
symbolic links for it.
If you want to know the details of upgraded components, see CHANGELOG.md.
NOTE: We explain for platform specific issue as "Additional hints for v4 users" section below.
During the upgrade process, plugins bundled in td-agent
are automatically upgraded. With that being said, other plugins added on your own are not included. You should review if you need to upgrade plugins since some directory structures from v4 and v5 are changed.
In this post, I will show steps with plugins added on my own, "fluent-plugin-concat" for instance. Here is sample configuration file I used through steps.
<filter docker.log>
@type concat
key message
multiline_start_regexp /^Start/
</filter>
$ td-agent-gem list | grep fluent-plugin*
fluent-plugin-calyptia-monitoring (0.1.3)
fluent-plugin-concat (2.5.0)
fluent-plugin-elasticsearch (5.3.0)
fluent-plugin-flowcounter-simple (0.1.0)
fluent-plugin-kafka (0.19.0)
fluent-plugin-metrics-cmetrics (0.1.2)
fluent-plugin-opensearch (1.1.0)
fluent-plugin-prometheus (2.0.3)
fluent-plugin-prometheus_pushgateway (0.1.0)
fluent-plugin-record-modifier (2.1.1)
fluent-plugin-rewrite-tag-filter (2.4.0)
fluent-plugin-s3 (1.7.2)
fluent-plugin-sd-dns (0.1.0)
fluent-plugin-systemd (1.0.5)
fluent-plugin-td (1.2.0)
fluent-plugin-utmpx (0.5.0)
fluent-plugin-webhdfs (1.5.0)
You can also find installed plugins under /opt/td-agent/lib/ruby/gems/2.7.0/gems/
directories.
$ ls -l /opt/td-agent/lib/ruby/gems/2.7.0/gems |grep fluent-plugin*
drwxr-xr-x. 5 root root 175 7月 14 03:01 fluent-plugin-calyptia-monitoring-0.1.3
drwxr-xr-x. 4 root root 206 7月 14 03:03 fluent-plugin-concat-2.5.0
drwxr-xr-x. 5 root root 4096 7月 14 03:01 fluent-plugin-elasticsearch-5.3.0
drwxr-xr-x. 4 root root 205 7月 14 03:01 fluent-plugin-flowcounter-simple-0.1.0
drwxr-xr-x. 6 root root 191 7月 14 03:01 fluent-plugin-kafka-0.19.0
drwxr-xr-x. 5 root root 190 7月 14 03:01 fluent-plugin-metrics-cmetrics-0.1.2
drwxr-xr-x. 5 root root 4096 7月 14 03:01 fluent-plugin-opensearch-1.1.0
drwxr-xr-x. 5 root root 215 7月 14 03:01 fluent-plugin-prometheus-2.0.3
drwxr-xr-x. 6 root root 238 7月 14 03:01 fluent-plugin-prometheus_pushgateway-0.1.0
drwxr-xr-x. 4 root root 176 7月 14 03:01 fluent-plugin-record-modifier-2.1.1
drwxr-xr-x. 3 root root 210 7月 14 03:01 fluent-plugin-rewrite-tag-filter-2.4.0
drwxr-xr-x. 5 root root 230 7月 14 03:01 fluent-plugin-s3-1.7.2
drwxr-xr-x. 3 root root 170 7月 14 03:01 fluent-plugin-sd-dns-0.1.0
drwxr-xr-x. 3 root root 49 7月 14 03:01 fluent-plugin-systemd-1.0.5
drwxr-xr-x. 5 root root 221 7月 14 03:01 fluent-plugin-td-1.2.0
drwxr-xr-x. 5 root root 166 7月 14 03:01 fluent-plugin-utmpx-0.5.0
drwxr-xr-x. 4 root root 191 7月 14 03:01 fluent-plugin-webhdfs-1.5.0
$ sudo systemctl stop td-agent
Even though fluent-package
supports upgrade without stopping service, but recommend to stop explicitly.
When you use RedHat or derivative distributions, you can run following script if you want to install normal release version of fluent-package
.
# curl -L https://toolbelt.treasuredata.com/sh/install-redhat-fluent-package5.sh | sh
When you use RedHat or derivative distributions, you can run following script if you want to install LTS (Long term support) version of fluent-package
.
# curl -L https://toolbelt.treasuredata.com/sh/install-redhat-fluent-package5-lts.sh | sh
You can find more information about the installation script in Fluend Doc - Installation.
$ LANG=C yum info fluent-package
Loaded plugins: fastestmirror
Loading mirror speeds from cached hostfile
* base: ftp.riken.jp
* extras: ftp.riken.jp
* updates: ftp.riken.jp
Installed Packages
Name : fluent-package
Arch : x86_64
Version : 5.0.0
Release : 1.el7
Size : 64 M
Repo : installed
From repo : /fluent-package-5.0.0-1.el7.x86_64
Summary : The stable distribution of Fluentd
URL : https://www.treasuredata.com/
License : ASL 2.0
Description : The stable distribution of Fluentd, called td-agent.
$ sudo systemctl daemon-reload
$ sudo systemctl enable --now fluentd
$ fluent-gem list |grep fluent-plugin*
fluent-plugin-calyptia-monitoring (0.1.3)
fluent-plugin-elasticsearch (5.3.0)
fluent-plugin-flowcounter-simple (0.1.0)
fluent-plugin-kafka (0.19.0)
fluent-plugin-metrics-cmetrics (0.1.2)
fluent-plugin-opensearch (1.1.0)
fluent-plugin-prometheus (2.0.3)
fluent-plugin-prometheus_pushgateway (0.1.0)
fluent-plugin-record-modifier (2.1.1)
fluent-plugin-rewrite-tag-filter (2.4.0)
fluent-plugin-s3 (1.7.2)
fluent-plugin-sd-dns (0.1.0)
fluent-plugin-systemd (1.0.5)
fluent-plugin-td (1.2.0)
fluent-plugin-utmpx (0.5.0)
fluent-plugin-webhdfs (1.5.0)
You can see bundled plugins are upgraded as well but can not find plugins added on your own. In this post, added plugin was "fluent-plugin-concat" and it is not shown in installed list.
$ sudo fluent-gem install fluent-plugin-concat
$ fluent-gem list | grep fluent-plugin*
fluent-plugin-calyptia-monitoring (0.1.3)
fluent-plugin-concat (2.5.0)
fluent-plugin-elasticsearch (5.3.0)
fluent-plugin-flowcounter-simple (0.1.0)
fluent-plugin-kafka (0.19.0)
fluent-plugin-metrics-cmetrics (0.1.2)
fluent-plugin-opensearch (1.1.0)
fluent-plugin-prometheus (2.0.3)
fluent-plugin-prometheus_pushgateway (0.1.0)
fluent-plugin-record-modifier (2.1.1)
fluent-plugin-rewrite-tag-filter (2.4.0)
fluent-plugin-s3 (1.7.2)
fluent-plugin-sd-dns (0.1.0)
fluent-plugin-systemd (1.0.5)
fluent-plugin-td (1.2.0)
fluent-plugin-utmpx (0.5.0)
fluent-plugin-webhdfs (1.5.0)
As for fluent-package v5, "fluent-plugin-concat" was installed under "/opt/fluent/lib/ruby/gems/3.2.0/gems/" directories.
$ ls -l /opt/fluent/lib/ruby/gems/3.2.0/gems/ |grep fluent-plugin*
drwxr-xr-x. 5 root root 175 7月 14 03:14 fluent-plugin-calyptia-monitoring-0.1.3
drwxr-xr-x. 4 root root 206 7月 14 03:16 fluent-plugin-concat-2.5.0
drwxr-xr-x. 5 root root 4096 7月 14 03:14 fluent-plugin-elasticsearch-5.3.0
drwxr-xr-x. 4 root root 205 7月 14 03:14 fluent-plugin-flowcounter-simple-0.1.0
drwxr-xr-x. 6 root root 191 7月 14 03:14 fluent-plugin-kafka-0.19.0
drwxr-xr-x. 5 root root 190 7月 14 03:14 fluent-plugin-metrics-cmetrics-0.1.2
drwxr-xr-x. 5 root root 4096 7月 14 03:14 fluent-plugin-opensearch-1.1.0
drwxr-xr-x. 5 root root 215 7月 14 03:14 fluent-plugin-prometheus-2.0.3
drwxr-xr-x. 6 root root 238 7月 14 03:14 fluent-plugin-prometheus_pushgateway-0.1.0
drwxr-xr-x. 4 root root 176 7月 14 03:14 fluent-plugin-record-modifier-2.1.1
drwxr-xr-x. 3 root root 210 7月 14 03:14 fluent-plugin-rewrite-tag-filter-2.4.0
drwxr-xr-x. 5 root root 230 7月 14 03:14 fluent-plugin-s3-1.7.2
drwxr-xr-x. 3 root root 170 7月 14 03:14 fluent-plugin-sd-dns-0.1.0
drwxr-xr-x. 3 root root 49 7月 14 03:14 fluent-plugin-systemd-1.0.5
drwxr-xr-x. 5 root root 221 7月 14 03:14 fluent-plugin-td-1.2.0
drwxr-xr-x. 5 root root 166 7月 14 03:14 fluent-plugin-utmpx-0.5.0
drwxr-xr-x. 4 root root 191 7月 14 03:14 fluent-plugin-webhdfs-1.5.0
$ sudo systemctl start fluentd
$ tail -100f /var/log/fluent/fluentd.log
Now, upgrading steps are completed. Happy Logging!
fluentd-apt-source
package will be marked as a transitional package.
you can remove it safely with sudo apt purge fluentd-apt-source
.td-agent.service
, you must explicitly execute the following commands: $ sudo systemctl unmask td-agent
$ sudo systemctl enable fluentd
td-agent.service
, you must explicitly execute the following command: $ sudo systemctl enable fluentd
fluent-package
installer was changed not to start service by default.
If you want to start fluentd
as a service, execute the following command with administrator privileges. c:\opt\fluent> net start fluentdwinsvc
WARNING: Currently we have no plan to officially support dmg version of fluent-package
yet.
It is just modified to be a minimally buildable state, it is for testing purpose only.
Fluentd is an open source data collector to simplify log management.
2024-08-29: Scheduled support lifecycle announcement about Fluent Package v6
2023-08-29: Drop schedule announcement about EOL of Treasure Agent (td-agent) 4
2023-08-29: Scheduled support lifecycle announcement about Fluent Package
2023-07-31: Upgrade to fluent-package v5
2024-08-29: Scheduled support lifecycle announcement about Fluent Package v6
2024-08-20: Fluentd v1.16.6 has been released
2024-08-19: Fluentd v1.17.1 has been released
2024-08-02: fluent-package v5.1.0 has been released
2024-07-02: fluent-package v5.0.4 has been released
2024-04-30: Fluentd v1.17.0 has been released
2024-03-29: fluent-package v5.0.3 has been released
2024-03-27: Fluentd v1.16.5 has been released
2024-03-14: Fluentd v1.16.4 has been released
2023-12-04: Open Source Summit Japan 2023
Want to learn the basics of Fluentd? Check out these pages.
Couldn't find enough information? Let's ask the community!
You need commercial-grade support from Fluentd committers and experts?
©2010-2024 Fluentd Project. ALL Rights Reserved.
Fluentd is a hosted project under the Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.