td-agent was discontinued in December 2023 and has been replaced by fluent-package. The fluent-package is the official successor maintained by the Cloud Native Computing Foundation.
Treasure Data provides Fluentd to collect server-side logs and events and to seamlessly import the data from Node.js applications.
The fluent-logger-node library enables Node.js applications to post records to their local Fluentd.
Fluentd, in turn, uploads the data to the cloud every 5 minutes. Because the daemon runs on a local node, the logging latency is negligible.
- Basic knowledge of Node.js and npm.
- Basic knowledge of Treasure Data.
- Node.js 22 or higher (for local testing).
Install Fluentd (fluent-package) on your application servers. Fluentd sits within your application servers, focusing on uploading application logs to the cloud.
The fluent-logger-node library enables Node.js applications to post records to their local Fluentd. Fluentd, in turn, uploads the data to the cloud every 5 minutes. Because the daemon runs on a local node, the logging latency is negligible.
td-agent was discontinued in December 2023 and has been replaced by fluent-package. The fluent-package is the official successor maintained by the Cloud Native Computing Foundation. For migration guidance from td-agent, see Fluentd Installation Guide.
To install fluent-package, run one of the following commands based on your environment.
# fluent-package 6 LTS (recommended)
curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package6-lts.sh | sh# Ubuntu 24.04 Noble - fluent-package 6 LTS
curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package6-lts.sh | sh
# Ubuntu 22.04 Jammy - fluent-package 6 LTS
curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package6-lts.sh | sh# Debian Bookworm - fluent-package 6 LTS
curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package6-lts.sh | sh# Amazon Linux 2023 - fluent-package 6 LTS
curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package6-lts.sh | shDownload the MSI installer from:
After installation:
- Edit the configuration file at
C:/opt/fluent/etc/fluent/fluentd.conf - Start the service using
net start fluentdwinsvcor via Services administrative tool
fluent-package for macOS is planned to be available via Homebrew. For current installation options, see Fluentd Installation Guide.
After installation, start and verify the Fluentd service.
sudo systemctl start fluentd.service
sudo systemctl status fluentd.serviceThe configuration file is located at /etc/fluent/fluentd.conf.
net start fluentdwinsvcThe configuration file is located at C:\opt\fluent\etc\fluent\fluentd.conf.
fluentd -c /path/to/fluentd.confFor more details, see the Fluentd Documentation.
Specify your API key by setting the apikey option in your /etc/fluent/fluentd.conf file (for fluent-package). You can view your API key from your profile in TD Console.
# Treasure Data Input and Output
<source>
@type forward
port 24224
</source>
<match td.*.*>
@type tdlog
endpoint api.treasuredata.com
apikey YOUR_API_KEY
auto_create_table
use_ssl true
<buffer>
@type file
path /var/log/fluent/buffer/td
</buffer>
</match>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 is recommended.
Restart the Fluentd service when the following lines are in place.
# Linux
sudo systemctl restart fluentd.service
# macOS (gem installation)
# Restart the Fluentd process manuallyFluentd now accepts data via port 24224, buffers the data (/var/log/fluent/buffer/td), and automatically uploads the data into the cloud.
Obtain the most recent version of fluent-logger-node.
A sample Express app using fluent-logger-node is as follows:
{
"name": "node-example",
"version": "0.0.1",
"dependencies": {
"express": "2.5.9",
"fluent-logger": "0.1.0"
}
}Now use npm to install your dependencies locally:
$ npm install
fluent-logger@0.1.0 ./node_modules/fluent-logger
express@2.5.9 ./node_modules/express
|-- qs@0.4.2
|-- mime@1.2.4
|-- mkdirp@0.3.0
|-- connect@1.8.6 (formidable@1.0.9)This is the simplest web app.
var express = require('express');
var app = express.createServer(express.logger());
var logger = require('fluent-logger');
logger.configure('td.test_db', {host: 'localhost', port: 24224});
app.get('/', function(request, response) {
logger.emit('follow', {from: 'userA', to: 'userB'});
response.send('Hello World!');
});
var port = process.env.PORT || 3000;
app.listen(port, function() {
console.log("Listening on " + port);
});Execute the app and go to http://localhost:3000/ in your browser.
$ node web.jsSending a SIGUSR1 signal flushes Fluentd's buffer. Upload starts immediately.
# Linux
$ kill -USR1 $(cat /var/run/fluent/fluentd.pid)
# macOS (gem installation)
# Send SIGUSR1 to the Fluentd processTo confirm that your data has been uploaded successfully, issue the td tables command as follows:
$ td tables
+------------+------------+------+-----------+
| Database | Table | Type | Count |
+------------+------------+------+-----------+
| test_db | follow | log | 1 |
+------------+------------+------+-----------+The first argument of post() determines the database name and table name. If you specify td.test\_db.test\_table, the data is imported into the table *test_table* within the database *test_db*. They are automatically created at upload time. |
For high-traffic websites (more than 5 application nodes), use a high availability configuration of Fluentd to improve data transfer reliability and query performance.
Monitoring Fluentd itself is also important. Refer to the following document for general monitoring methods for Fluentd.
Fluentd is fully open-sourced under the Fluentd project.
We offer a schema mechanism that is more flexible than that of traditional RDBMSs. For queries, we leverage the Hive and Trino Query Languages.