Install by .dmg Package v3 (macOS)

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.

td-agent v3

NOTE: As Treasure Agent (td-agent) 3 will not be maintained anymore, recommend to Upgrade td-agent from v3 to v4.

Step 1: Install td-agent

Download and install the .dmg package:

• 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).

$ sudo launchctl load /Library/LaunchDaemons/td-agent.plist
$ less /var/log/td-agent/td-agent.log
2018-01-01 16:55:03 -0700 [info]: starting fluentd-1.0.2
2018-01-01 16:55:03 -0700 [info]: reading config file path="/etc/td-agent/td-agent.conf"

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:

$ sudo launchctl unload /Library/LaunchDaemons/td-agent.plist

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:

$ curl -X POST -d 'json={"json":"message"}' http://localhost:8888/debug.test
$ tail -n 1 /var/log/td-agent/td-agent.log
2018-01-01 17:51:47 -0700 debug.test: {"json":"message"}

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

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.