Treasure Data provides Treasure Agent (td-agent), to collect server-side logs and events and seamlessly import the data from Java applications.


  • Basic knowledge of Java.

  • Basic knowledge of Maven.

  • Basic knowledge of Treasure Data.

  • Java 6 or higher (for local testing).

Installing td-agent

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

The td-logger-java library enables Java 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.

Install Options

td-agent, a stable distribution package of fluentd, is installed automatically when you use the package management software for each platform like rpm/deb/dmg. Refer to Installing td-agent for detailed instructions for each platform.

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

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

# Input from Logger 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 profiles in TD Console. Using a [write-only API key](access-control#rest-apis-access) is recommended.

Restart your agent when 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 it (var/log/td-agent/buffer/td), and automatically uploads it into the cloud.

Using td-logger-java

If you need an all-in-one JAR file, see Download the latest version of the td-logger-{version_number}-jar-with-dependencies.jar file.

If you are using Maven, add the following lines to pom.xml in your Maven project:


Configure your file using the following commands:


You must ensure that the file is referenced by your Java classpath.

Insert the following lines into your application. For more information regarding the API, see here.

import com.treasure_data.logger.TreasureDataLogger;
public class Main {
  private static TreasureDataLogger LOG;
  static {
    try {
      Properties props = System.getProperties();
      LOG = TreasureDataLogger.getLogger("test_db");
    } catch (IOException e) {
      // do something
  public void doApp() {
    Map<String, Object> data = new HashMap<String, Object>();
    data.put("from", "userA");
    data.put("to", "userB");
    LOG.log("follow", data);

Confirming Data Import

Execute the program.

# Post a record
$ java -jar test.jar

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`

From TD Console

To confirm that your data has been uploaded successfully, check your dataset from the web browser.

From CLI

Or, issue the td tables command if you have a td CLI client.

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

Production Deployments

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.

  • No labels