Skip to main content

StatsD Writing

StatsD is a simple daemon for aggregating application metrics, which has evolved rapidly in recent years into a unified protocol for collecting application performance metrics.

You can write StatsD data to TDengine by simply modifying the configuration file of StatsD with the domain name (or IP address) of the server running taosAdapter and the corresponding port. It can take full advantage of TDengine's efficient storage query performance and clustering capabilities for time-series data.

Prerequisites

To write StatsD data to TDengine requires the following preparations.

  1. The TDengine cluster is deployed and functioning properly
  2. taosAdapter is installed and running properly. Please refer to the taosAdapter manual for details.

Configuration steps

Configuring taosAdapter

To configure taosAdapter to receive StatsD data.

  • Enable the configuration item in the taosAdapter configuration file (default location /etc/taos/taosadapter.toml)
...
[statsd]
enable = true
port = 6044
db = "statsd"
user = "root"
password = "taosdata"
worker = 10
gatherInterval = "5s"
protocol = "udp"
maxTCPConnections = 250
tcpKeepAlive = false
allowPendingMessages = 50000
deleteCounters = true
deleteGauges = true
deleteSets = true
deleteTimings = true
...

The default database name written by taosAdapter is statsd. To specify a different name, you can also modify the taosAdapter configuration file db entry. user and password fill in the actual TDengine configuration values. After changing the configuration file, you need to restart the taosAdapter.

  • You can also enable taosAdapter to receive StatsD data by using the taosAdapter command-line parameters or setting environment variables.

Configuring StatsD

To use StatsD, you need to download its source code. Please refer to the example file exampleConfig.js in the root directory of the source download to modify the configuration file. In <taosAdpater's host>, please fill in the domain name or IP address of the server running taosAdapter, and <port for StatsD>, please fill in the port where taosAdapter receives StatsD data (default is 6044).

backends section add ". /backends/repeater"
Add { host:'<taosAdapter's host>', port: <port for StatsD>} to repeater section

Example configuration file.

{
port: 8125
, backends: [". /backends/repeater"]
, repeater: [{ host: '127.0.0.1', port: 6044}]
}

Start StatsD after adding the following (assuming the config file is modified to config.js)

node stats.js config.js &

Verification method

Start StatsD:

$ node stats.js config.js &
[1] 8546
$ 20 Apr 09:54:41 - [8546] reading config file: exampleConfig.js
20 Apr 09:54:41 - server is up INFO

Using the utility software nc to write data for test:

$ echo "foo:1|c" | nc -u -w0 127.0.0.1 8125

Use the TDengine CLI to verify that StatsD data is written to TDengine and can read out correctly.

taos> show databases;
name | created_time | ntables | vgroups | replica | quorum | days | keep | cache(MB) | blocks | minrows | maxrows | wallevel | fsync | comp | cachelast | precision | update | status |
====================================================================================================================================================================================================================================================================================
log | 2022-04-20 07:19:50.260 | 11 | 1 | 1 | 1 | 10 | 3650 | 16 | 6 | 100 | 4096 | 1 | 3000 | 2 | 0 | ms | 0 | ready |
statsd | 2022-04-20 09:54:51.220 | 1 | 1 | 1 | 1 | 10 | 3650 | 16 | 6 | 100 | 4096 | 1 | 3000 | 2 | 0 | ns | 2 | ready |
Query OK, 2 row(s) in set (0.003142s)

taos> use statsd;
Database changed.

taos> show stables;
name | created_time | columns | tags | tables |
============================================================================================
foo | 2022-04-20 09:54:51.234 | 2 | 1 | 1 |
Query OK, 1 row(s) in set (0.002161s)

taos> select * from foo;
ts | value | metric_type |
=======================================================================================
2022-04-20 09:54:51.219614235 | 1 | counter |
Query OK, 1 row(s) in set (0.004179s)

taos>