Treasure Data provides td-agent to collect server-side logs and events and to seamlessly import the data from Ruby applications.


Installing td-agent

Install td-agenton your application servers. td-agent sits within your application servers, focusing on uploading application logs to the cloud.

The td-logger-ruby library enables Ruby applications to post records to their local td-agent. td-agent, in turn, receives the records, buffers them, and uploads the data to the cloud every 5 minutes. Because the daemon runs on a local node, the logging latency is negligible.

td-agent Install Options

To install td-agent, run one of the following commands based on your environment. The agent program is installed automatically by using the package management software for each platform like rpm/deb/dmg.

RHEL/CentOS 5,6,7

$ curl -L | sh

Ubuntu and Debian

# 18.04 Bionic
$ curl -L | sh
# 16.04 Xenial (64bit only)
$ curl -L | sh
Legacy support for EOL versions is still available
# 14.04 Trusty
$ curl -L | sh
# 12.04 Precise
$ curl -L | sh
# Debian Stretch (64-bit only) $ curl -L | sh
# Debian Jessie (64-bit only)
$ curl -L | sh
# Debian Squeeze (64-bit only)
$ curl -L | sh

Amazon Linux

You can choose Amazon Linux 1 or Amazon Linux 2. Refer to Installing td-agent on Amazon Linux.

MacOS X 10.11+

$ open ''

MacOS X 10.11.1 (El Capitan) introduces some security changes. After the td-agent is installed, edit the /Library/LaunchDaemons/td-agent.plist file to change /usr/sbin/td-agent to /opt/td-agent/usr/sbin/td-agent.

Windows Server 2012+

The Windows installation requires the steps detailed in:

Opscode Chef Repository

$ echo 'cookbook "td-agent"' >> Berksfile
$ berks install

AWS Elastic Beanstalk is also supported. Windows is not supported.

Modifying /etc/td-agent/td-agent.conf

Specify your API key by setting the apikey option in your /etc/td-agent/td-agent.conf file.

# Input from Logging Libraries
  type forward
  port 24224

# Treasure Data Output
<match td.*.*>
  type tdlog
  apikey YOUR_API_KEY
  buffer_type file
  buffer_path /var/log/td-agent/buffer/td
  use_ssl true

YOUR_API_KEY should be your actual apikey string. You can retrieve your API key from your profile in TD Console. Using the [write-only key](access-control#rest-apis-access) is recommended.

Restart your agent after the following lines are in place.

# Linux
$ sudo /etc/init.d/td-agent restart

# MacOS X
$ sudo launchctl unload /Library/LaunchDaemons/td-agent.plist
$ sudo launchctl load /Library/LaunchDaemons/td-agent.plist

td-agent accepts data via port 24224, buffers the data (var/log/td-agent/buffer/td), and automatically uploads the data into the cloud.

Using td-logger-ruby

Add the ‘td’ gem to your Gemfile.

gem 'td', "~> 0.10.6"

Initialize and post the records.

# Initialize
require 'td'
TreasureData::Logger.open_agent('td.test_db', :host=>'localhost', :port=>24224)

# Example1: login event'login', {:uid=>123})

# Example2: follow event'follow', {:uid=>123, :from=>'TD', :to=>'Heroku'})

# Example3: pay event'pay',
              {:uid=>123, :item_name=>'Stone of Jordan',
               :category=>'ring', :price=>100, :count=>1})

Confirming Data Import

Execute the program.

$ ruby test.rb

Sending a SIGUSR1 signal flushes td-agent’s buffer. The upload starts immediately.

# Linux
$ kill -USR1 `cat /var/run/td-agent/`

# MacOS X
$ sudo kill -USR1 `sudo launchctl list | grep td-agent | cut -f 1`

Using TD Console

To confirm that your data has been uploaded successfully, check your data set.

From CLI

Or, issue the td tables command if you have a CLI for TD toolbelt.

$ td tables
| Database   | Table      | Type | Count     |
| test_db    | login      | log  | 1         |
| test_db    | follow     | log  | 1         |
| test_db    | pay        | log  | 1         |

Production Deployments

Use Rack-Based Server Deployments

We recommend that you use unicorn, thin, mongrel, etc. Other setups have not been fully validated.

High Availability Configurations of td-agent

For high-traffic websites (more than 5 application nodes), use a high availability configuration of td-agent to improve data transfer reliability and query performance.

Monitoring td-agent

Monitoring td-agent itself is also important. For general monitoring methods for td-agent, see Monitoring td-agent.

td-agent is fully open-sourced under the Fluentd project.