Install by .dmg Package (macOS)

Search…

This article explains how to install td-agent, the stable Fluentd distribution package maintained by Treasure Data, Inc, on macOS.
What is td-agent?
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 Treasure Data, Inc provides the stable distribution of Fluentd, called td-agent. The differences between Fluentd and td-agent can be found here.
What is 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.
For macOS, td-agent is distributed as .dmg installer.
td-agent v3/v4
Step 1: Install td-agent
Download and install the .dmg package:
​td-agent v4​
​td-agent v3​
NOTE: If your OS is not supported, consider gem installation instead.
Step 2: Launch td-agent
Use launchctl command to launch td-agent. Make sure that the daemon is started correctly. Checks logs (/var/log/td-agent/td-agent.log).
1
$ sudo launchctl load /Library/LaunchDaemons/td-agent.plist
2
$ less /var/log/td-agent/td-agent.log
3
2018-01-01 16:55:03 -0700 [info]: starting fluentd-1.0.2
4
2018-01-01 16:55:03 -0700 [info]: reading config file path="/etc/td-agent/td-agent.conf"
Copied!
The configuration file is located at /etc/td-agent/td-agent.conf and the plugin directory is at /etc/td-agent/plugin.
To stop the agent, run this command:
1
$ sudo launchctl unload /Library/LaunchDaemons/td-agent.plist
Copied!
Step 3: Post Sample Logs via HTTP
The default configuration (/etc/td-agent/td-agent.conf) is to receive logs at an HTTP endpoint and route them to stdout. For td-agent logs, see /var/log/td-agent/td-agent.log.
You can post sample log records with curl command:
1
$ curl -X POST -d 'json={"json":"message"}' http://localhost:8888/debug.test
2
$ tail -n 1 /var/log/td-agent/td-agent.log
3
2018-01-01 17:51:47 -0700 debug.test: {"json":"message"}
Copied!
Uninstall td-agent
On macOS, td-agent does not provide any uninstallation app like rpm / deb on Ubuntu.
To uninstall td-agent from macOS, remove these files / directories:
/Library/LaunchDaemons/td-agent.plist
/etc/td-agent
/opt/td-agent
/var/log/td-agent
calyptia-fluentd v1
Step 1: Install calyptia-fluentd
Download and install the .dmg package:
​calyptia-fluentd v1​
NOTE: If your OS is not supported, consider gem installation instead. NOTE: Since calyptia-fluentd v1.3.1, intel version and apple silicon version of packages are provided. -intel suffix is for Intel version and -apple suffix is for Apple Silicon.
Step 2: Launch calyptia-fluentd
Use launchctl command to launch calyptia-fluentd. Make sure that the daemon is started correctly. Checks logs (/var/log/calyptia-fluentd/calyptia-fluentd.log).
1
$ sudo launchctl load /Library/LaunchDaemons/calyptia-fluentd.plist
2
$ less /var/log/calyptia-fluentd/calyptia-fluentd.log
3
2021-05-31 14:29:38 +0900 [info]: starting fluentd-1.12.3 pid=72608 ruby="3.0.1"
4
2021-05-31 14:29:38 +0900 [info]: spawn command to main:  cmdline=["/opt/calyptia-fluentd/bin/ruby", "-Eascii-8bit:ascii-8bit", "/opt/calyptia-fluentd/usr/sbin/calyptia-fluentd", "--log", "/var/log/calyptia-fluentd/calyptia-fluentd.log", "--use-v1-config", "--under-supervisor"]
Copied!
The configuration file is located at /etc/calyptia-fluentd/calyptia-fluentd.conf and the plugin directory is at /etc/calyptia-fluentd/plugin.
To stop the agent, run this command:
1
$ sudo launchctl unload /Library/LaunchDaemons/calyptia-fluentd.plist
Copied!
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:
1
$ curl -X POST -d 'json={"json":"message"}' http://localhost:8888/debug.test
2
$ tail -n 1 /var/log/calyptia-fluentd/calyptia-fluentd.log
3
2021-05-31 14:32:02.707482000 +0900 debug.test: {"json":"message"}
Copied!
Uninstall calyptia-fluentd
On macOS, calyptia-fluentd uses dmg which includes macOS installer a.k.a. pkg. It does not provide any uninstallation app functionality like rpm / deb on CentOS / Ubuntu.
To uninstall calyptia-fluentd from macOS, remove these files / directories:
/Library/LaunchDaemons/calyptia-fluentd.plist
/etc/calyptia-fluentd
/opt/calyptia-fluentd
/var/log/calyptia-fluentd
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
​Config File​
Application Logs
​Ruby, Java, Python, PHP,
​Perl, Node.js, Scala​
Examples
​Store Apache Log into Amazon S3​
​Store Apache Log into MongoDB​
​Data Collection into HDFS​
For further steps, follow these:
​ChangeLog of td-agent​
​Chef Cookbook​
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.