taosAdapter 参考手册
taosAdapter 是一个 TDengine 的配套工具,是 TDengine 集群和应用程序之间的桥梁和适配器。它提供了一种易于使用和高效的方式来直接从数据收集代理软件(如 Telegraf、StatsD、collectd 等)摄取数据。它还提供了 InfluxDB/OpenTSDB 兼容的数据摄取接口,允许 InfluxDB/OpenTSDB 应用程序无缝移植到 TDengine。 TDengine 的各语言连接器通过 WebSocket 接口与 TDengine 进行通信,因此必须安装 taosAdapter。
架构图如下:
功能列表
taosAdapter 提供了以下功能:
- WebSocket 接口: 支持通过 WebSocket 协议执行 SQL、无模式数据写入、参数绑定和数据订阅功能。
- InfluxDB v1 数据写入: https://docs.influxdata.com/influxdb/v2.0/reference/api/influxdb-1x/write/
- 兼容 OpenTSDB JSON 和 telnet 格式写入:
- collectd 数据写入: collectd 是一个系统统计收集守护程序,请访问 https://collectd.org/ 了解更多信息。
- StatsD 数据写入: StatsD 是一个简单而强大的统计信息汇总的守护程序。请访问 https://github.com/statsd/statsd 了解更多信息。
- icinga2 OpenTSDB writer 数据写入: icinga2 是一个收集检查结果指标和性能数据的软件。请访问 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer 了解更多信息。
- TCollector 数据写入: TCollector 是一个客户端进程,从本地收集器收集数据,并将数据推送到 OpenTSDB。请访问 http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html 了解更多信息。
- node_exporter 采集写入: node_export 是一个机器指标的导出器。请访问 https://github.com/prometheus/node_exporter 了解更多信息。
- Prometheus remote_read 和 remote_write: remote_read 和 remote_write 是 Prometheus 数据读写分离的集群方案。请访问 https://prometheus.io/blog/2019/10/10/remote-read-meets-streaming/#remote-apis 了解更多信息。
- RESTful 接口: RESTful API
WebSocket 接口
各语言连接器通过 taosAdapter 的 WebSocket 接口,能够实现 SQL 执行、无模式写入、参数绑定和数据订阅功能。参考 开发指南。
InfluxDB v1 数据写入
您可以使用任何支持 HTTP 协议的客户端访问 Restful 接口地址 http://<fqdn>:6041/influxdb/v1/write
来写入 InfluxDB 兼容格式的数据到 TDengine。
支持 InfluxDB 参数如下:
db
指定 TDengine 使用的数据库名precision
TDengine 使用的时间精度u
TDengine 用户名p
TDengine 密码ttl
自动创建的子表生命周期,以子表的第一条数据的 TTL 参数为准,不可更新。更多信息请参考 创建表文档的 TTL 参数。
注意:目前不支持 InfluxDB 的 token 验证方式,仅支持 Basic 验证和查询参数验证。 示例:
curl --request POST http://127.0.0.1:6041/influxdb/v1/write?db=test --user "root:taosdata" --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
OpenTSDB JSON 和 telnet 格式写入
您可以使用任何支持 HTTP 协议的客户端访问 Restful 接口地址 http://<fqdn>:6041/<APIEndPoint>
来写入 OpenTSDB 兼容格式的数据到 TDengine。EndPoint 如下:
/opentsdb/v1/put/json/<db>
/opentsdb/v1/put/telnet/<db>
collectd 数据写入
collectd 使用插件机制可以以多种形式将采集到的监控数据写入到不同的数据存储软件。TDengine 支持写入 collectd write_tsdb 插件数据和 collectd 二进制数据。
collectd write_tsdb 插件是 collectd 官方提供的插件,支持将数据转为 OpenTSDB 协议格式发送到后端存储。
collectd write_tsdb 插件数据写入
配置 taosAdapter
- 在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
tcpKeepAlive = false
dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...
其中 taosAdapter 默认写入的数据库名称为 collectd
,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。
- 使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 collectd 数据功能,具体细节请参考 taosAdapter 的参考手册。
配置 collectd
修改 collectd 配置文件(默认位置 /etc/collectd/collectd.conf)相关配置项。
LoadPlugin write_tsdb
<Plugin write_tsdb>
<Node>
Host "<taosAdapter's host>"
Port "<port for collectd write_tsdb plugin>"
...
</Node>
</Plugin>
其中 <taosAdapter's host> 填写运行 taosAdapter 的服务器域名或 IP 地址。<port for collectd write_tsdb plugin> 填写 taosAdapter 用于接收 collectd write_tsdb 插件的数据(默认为 6047)。
LoadPlugin write_tsdb
<Plugin write_tsdb>
<Node>
Host "127.0.0.1"
Port "6047"
HostTags "status=production"
StoreRates false
AlwaysAppendDS false
</Node>
</Plugin>
然后重启 collectd:
systemctl restart collectd
collectd 二进制数据写入
配置 taosAdapter
-
在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
...
[collectd]
enable = true
port = 6045
db = "collectd"
user = "root"
password = "taosdata"
worker = 10
...其中 taosAdapter 默认写入的数据库名称为
collectd
,也可以修改 taosAdapter 配置文件 db 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 -
使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 collectd 数据功能,具体细节请参考 taosAdapter 的参考手册。
配置 collectd
修改 collectd 配置文件(默认位置 /etc/collectd/collectd.conf)相关配置项。
LoadPlugin network
<Plugin network>
Server "<taosAdapter's host>" "<port for collectd direct>"
</Plugin>
其中 <taosAdapter's host> 填写运行 taosAdapter 的服务器域名或 IP 地址。<port for collectd direct> 填写 taosAdapter 用于接收 collectd 数据的端口(默认为 6045)。
示例如下:
LoadPlugin network
<Plugin network>
Server "127.0.0.1" "6045"
</Plugin>
然后重启 collectd:
systemctl restart collectd
StatsD 数据写入
配置 taosAdapter
配置 taosAdapter 接收 StatsD 数据的方法:
-
在 taosAdapter 配置文件(默认位置 /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
...其中 taosAdapter 默认写入的数据库名称为
statsd
,也可以修改 taosAdapter 配置文件 db 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 -
使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 StatsD 数据功能,具体细节请参考 taosAdapter 的参考手册
配置 StatsD
使用 StatsD 需要下载其源代码。其配置文件请参考其源代码下载到本地的根目录下的示例文件 exampleConfig.js
进行修改。其中 <taosAdapter's host> 填写运行 taosAdapter 的服务器域名或 IP 地址,<port for StatsD> 请填写 taosAdapter 接收 StatsD 数据的端口(默认为 6044)。
backends 部分添加 "./backends/repeater"
repeater 部分添加 { host:'<taosAdapter's host>', port: <port for StatsD>}
示例配置文件:
{
port: 8125
, backends: ["./backends/repeater"]
, repeater: [{ host: '127.0.0.1', port: 6044}]
}
增加如下内容后启动 StatsD(假设配置文件修改为 config.js)。
npm install
node stats.js config.js &
icinga2 OpenTSDB writer 数据写入
配置 taosAdapter
配置 taosAdapter 接收 icinga2 数据的方法:
-
在 taosAdapter 配置文件(默认位置 /etc/taos/taosadapter.toml)中使能配置项
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
tcpKeepAlive = false
dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...其中 taosAdapter 默认写入的数据库名称为
icinga2
,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过 taosAdapter 需重新启动。 -
使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 icinga2 数据功能,具体细节请参考 taosAdapter 的参考手册
配置 icinga2
-
使能 icinga2 的 opentsdb-writer(参考链接 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer)
-
修改配置文件
/etc/icinga2/features-enabled/opentsdb.conf
填写 <taosAdapter's host> 为运行 taosAdapter 的服务器的域名或 IP 地址,<port for icinga2> 填写 taosAdapter 支持接收 icinga2 数据的相应端口(默认为 6048)object OpenTsdbWriter "opentsdb" {
host = "<taosAdapter's host>"
port = <port for icinga2>
}示例文件:
object OpenTsdbWriter "opentsdb" {
host = "127.0.0.1"
port = 6048
}
TCollector 数据写入
配置 taosAdapter
配置 taosAdapter 接收 TCollector 数据的方法:
-
在 taosAdapter 配置文件(默认位置 /etc/taos/taosadapter.toml)中使能配置项
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
tcpKeepAlive = false
dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...其中 taosAdapter 默认写入的数据库名称为
tcollector
,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 -
使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 tcollector 数据功能,具体细节请参考 taosAdapter 的参考手册
配置 TCollector
使用 TCollector 需下载其源代码。其配置项在其源代码中。注意:TCollector 各个版本区别较大,这里仅以当前 master 分支最新代码 (git commit: 37ae920) 为例。
修改 collectors/etc/config.py
和 tcollector.py
两个文件中相应内容。将原指向 OpenTSDB 宿主机的地址修改为 taosAdapter 被部署的服务器域名或 IP 地址,修改端口为 taosAdapter 支持 TCollector 使用的相应端口(默认为 6049)。
示例为源代码修改内容的 git diff 输出:
index e7e7a1c..ec3e23c 100644
--- a/collectors/etc/config.py
+++ b/collectors/etc/config.py
@@ -59,13 +59,13 @@ def get_defaults():
'http_password': False,
'reconnectinterval': 0,
'http_username': False,
- 'port': 4242,
+ 'port': 6049,
'pidfile': '/var/run/tcollector.pid',
'http': False,
'http_api_path': "api/put",
'tags': [],
'remove_inactive_collectors': False,
- 'host': '',
+ 'host': '127.0.0.1',
'logfile': '/var/log/tcollector.log',
'cdir': default_cdir,
'ssl': False,
diff --git a/tcollector.py b/tcollector.py
index 21f9b23..4c71ba2 100755
--- a/tcollector.py
+++ b/tcollector.py
@@ -64,7 +64,7 @@ ALIVE = True
# exceptions, something is not right and tcollector will shutdown.
# Hopefully some kind of supervising daemon will then restart it.
MAX_UNCAUGHT_EXCEPTIONS = 100
-DEFAULT_PORT = 4242
+DEFAULT_PORT = 6049
MAX_REASONABLE_TIMESTAMP = 2209212000 # Good until Tue 3 Jan 14:00:00 GMT 2040
# How long to wait for datapoints before assuming
# a collector is dead and restarting it
@@ -943,13 +943,13 @@ def parse_cmdline(argv):
'http_password': False,
'reconnectinterval': 0,
'http_username': False,
- 'port': 4242,
+ 'port': 6049,
'pidfile': '/var/run/tcollector.pid',
'http': False,
'http_api_path': "api/put",
'tags': [],
'remove_inactive_collectors': False,
- 'host': '',
+ 'host': '127.0.0.1',
'logfile': '/var/log/tcollector.log',
'cdir': default_cdir,
'ssl': False,
node_exporter 采集写入
Prometheus 使用的由 *NIX 内核暴露的硬件和操作系统指标的输出器
- 启用 taosAdapter 的配置 node_exporter.enable
- 设置 node_exporter 的相关配置
- 重新启动 taosAdapter
Prometheus remote_read 和 remote_write
配置 Prometheus 是通过编辑 Prometheus 配置文件 prometheus.yml(默认位置 /etc/prometheus/prometheus.yml)完成的。
配置第三方数据库地址
将其中的 remote_read url 和 remote_write url 指向运行 taosAdapter 服务的服务器域名或 IP 地址,REST 服务端口(taosAdapter 默认使用 6041),以及希望写入 TDengine 的数据库名称,并确保相应的 URL 形式如下:
- remote_read url :
http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_read/<database name>
- remote_write url :
http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_write/<database name>
配置 Basic 验证
- username: <TDengine's username>
- password: <TDengine's password>
prometheus.yml 文件中 remote_write 和 remote_read 相关部分配置示例
remote_write:
- url: "http://localhost:6041/prometheus/v1/remote_write/prometheus_data"
basic_auth:
username: root
password: taosdata
remote_read:
- url: "http://localhost:6041/prometheus/v1/remote_read/prometheus_data"
basic_auth:
username: root
password: taosdata
remote_timeout: 10s
read_recent: true
RESTful 接口
您可以使用任何支持 HTTP 协议的客户端通过访问 RESTful 接口地址 http://<fqdn>:6041/rest/sql
来写入数据到 TDengine 或从 TDengine 中查询数据。细节请参考 REST API 文档。
安装
taosAdapter 是 TDengine 服务端软件 的一部分,如果您使用 TDengine server 您不需要任何额外的步骤来安装 taosAdapter。您可以从 涛思数据官方网站 下载 TDengine server 安装包。如果需要将 taosAdapter 分离部署在 TDengine server 之外的服务器上,则应该在该服务器上安装完整的 TDengine 来安装 taosAdapter。如果您需要使用源代码编译生成 taosAdapter,您可以参考 构建 taosAdapter 文档。
安装完成后使用命令 systemctl start taosadapter
可以启动 taosAdapter 服务。
配置
taosAdapter 支持通过命令行参数、环境变量和配置文件来进行配置。默认配置文件是 /etc/taos/taosadapter.toml,可用过 -c
或 --config
命令行参数指定配置文件。
命令行参数优先于环境变量优先于配置文件,命令行用法是 arg=val,如 taosadapter -p=30000 --debug=true。
示例配置文件参见 example/config/taosadapter.toml。
基础配置
taosAdapter 的基础配置参数如下:
debug
:是否启用调试模式(pprof)- 设置为
true
时:(默认值)启用 go pprof 调试模式,允许使用http://<fqdn>:<port>/debug/pprof
访问调试信息。 - 设置为
false
时:关闭调试模式,不允许访问调试信息。
- 设置为
instanceId
:taosAdapter 实例 id,用于区分不同 taosAdapter 的日志,默认值:32。port
:taosAdapter 对外提供 HTTP/WebSocket 服务的端口,默认值:6041。taosConfigDir
:TDengine 的配置文件目录,默认值:/etc/taos
。该目录下的taos.cfg
文件将被加载。
从 3.3.4.0 版本 开始,taosAdapter 支持设置调用 C 方法并发调用数:
-
maxAsyncConcurrentLimit
设置 C 异步方法的最大并发调用数(0 表示使用 CPU 核心数)。
-
maxSyncConcurrentLimit
设置 C 同步方法的最大并发调用数(0 表示使用 CPU 核心数)。
跨域配置
使用浏览器进行接口调用时,请根据实际情况设置如下跨域(CORS)参数:
cors.allowAllOrigins
:是否允许所有来源访问,默认为true
。cors.allowOrigins
:允许跨域访问的来源列表,支持多个来源,以逗号分隔。cors.allowHeaders
:允许跨域访问的请求头列表,支持多个请求头,以逗号分隔。cors.exposeHeaders
:允许跨域访问的响应头列表,支持多个响应头,以逗号分隔。cors.allowCredentials
:是否允许跨域请求包含用户凭证,如 cookies、HTTP 认证信息或客户端 SSL 证书。cors.allowWebSockets
:是否允许 WebSockets 连接。
如果不通过浏览器进行接口调用无需关心这几项配置。
以上配置对以下接口生效:
- RESTful 接口请求
- WebSocket 接口请求
- InfluxDB v1 写接口
- OpenTSDB HTTP 写入接口
关于 CORS 协议细节请参考:https://www.w3.org/wiki/CORS_Enabled 或 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/CORS。
连接池配置
taosAdapter 使用连接池管理与 TDengine 的连接,以提高并发性能和资源利用率。连接池配置对以下接口生效,且以下接口共享一个连接池:
- RESTful 接口请求
- InfluxDB v1 写接口
- OpenTSDB JSON 和 telnet 格式写入
- Telegraf 数据写入
- collectd 数据写入
- StatsD 数据写入
- 采集 node_exporter 数据写入
- Prometheus remote_read 和 remote_write
连接池的配置参数如下:
pool.maxConnect
:连接池允许的最大连接数,默认值为 2 倍 CPU 核心数。建议保持默认设置。pool.maxIdle
:连接池中允许的最大空闲连接数,默认与pool.maxConnect
相同。建议保持默认设置。pool.idleTimeout
:连接空闲超时时间,默认永不超时。建议保持默认设置。pool.waitTimeout
:从连接池获取连接的超时时间,默认设置为 60 秒。如果在超时时间内未能获取连接,将返回 HTTP 状态码 503。该参数从版本 3.3.3.0 开始提供。pool.maxWait
:连接池中等待获取连接的请求数上限,默认值为 0,表示不限制。当排队请求数超过此值时,新的请求将返回 HTTP 状态码 503。该参数从版本 3.3.3.0 开始提供。
HTTP 返回码配置
taosAdapter 通过参数 httpCodeServerError
来控制当底层 C 接口返回错误时,是否在 RESTful 接口请求中返回非 200 的 HTTP 状态码。当设置为 true
时,taosAdapter 会根据 C 接口返回的错误码映射为相应的 HTTP 状态码。具体映射规则请参考 HTTP 响应码。
该配置只会影响 RESTful 接口。
参数说明
httpCodeServerError
:- 设置为
true
时:根据 C 接口返回的错误码映射为相应的 HTTP 状态码。 - 设置为
false
时:无论 C 接口返回什么错误,始终返回 HTTP 状态码200
(默认值)。
- 设置为
内存限制配置
taosAdapter 将监测自身运行过程中内存使用率并通过两个阈值进行调节。有效值范围为 1 到 100 的整数,单位为系统物理内存的百分比。
该配置只会影响以下接口:
- RESTful 接口请求
- InfluxDB v1 写接口
- OpenTSDB HTTP 写入接口
- Prometheus remote_read 和 remote_write 接口
参数说明
pauseQueryMemoryThreshold
:- 当内存使用超过此阈值时,taosAdapter 将停止处理查询请求。
- 默认值:
70
(即 70% 的系统物理内存)。
pauseAllMemoryThreshold
:- 当内存使用超过此阈值时,taosAdapter 将停止处理所有请求(包括写入和查询)。
- 默认值:
80
(即 80% 的系统物理内存)。
当内存使用回落到阈值以下时,taosAdapter 会自动恢复相应功能。
HTTP 返回内容:
- 超过
pauseQueryMemoryThreshold
时:- HTTP 状态码:
503
- 返回内容:
"query memory exceeds threshold"
- HTTP 状态码:
- 超过
pauseAllMemoryThreshold
时:- HTTP 状态码:
503
- 返回内容:
"memory exceeds threshold"
- HTTP 状态码:
状态检查接口:
可以通过以下接口检查 taosAdapter 的内存状态:
- 正常状态:
http://<fqdn>:6041/-/ping
返回code 200
。 - 内存超过阈值:
- 如果内存超过
pauseAllMemoryThreshold
,返回code 503
。 - 如果内存超过
pauseQueryMemoryThreshold
,且请求参数包含action=query
,返回code 503
。
- 如果内存超过
相关配置参数:
monitor.collectDuration
:内存监控间隔,默认值为3s
,环境变量为TAOS_MONITOR_COLLECT_DURATION
。monitor.incgroup
:是否在容器中运行(容器中运行设置为true
),默认值为false
,环境变量为TAOS_MONITOR_INCGROUP
。monitor.pauseQueryMemoryThreshold
:查询请求暂停的内存阈值(百分比),默认值为70
,环境变量为TAOS_MONITOR_PAUSE_QUERY_MEMORY_THRESHOLD
。monitor.pauseAllMemoryThreshold
:查询和写入请求暂停的内存阈值(百分比),默认值为80
,环境变量为TAOS_MONITOR_PAUSE_ALL_MEMORY_THRESHOLD
。
您可以根据具体项目应用场景和运营策略进行相应调整,并建议使用运营监控软件及时进行系统内存状态监控。负载均衡器也可以通过这个接口检查 taosAdapter 运行状态。
无模式写入创建 DB 配置
从 3.0.4.0 版本 开始,taosAdapter 提供了参数 smlAutoCreateDB
,用于控制在 schemaless 协议写入时是否自动创建数据库(DB)。
smlAutoCreateDB
参数只会影响以下接口:
- InfluxDB v1 写接口
- OpenTSDB JSON 和 telnet 格式写入
- Telegraf 数据写入
- collectd 数据写入
- StatsD 数据写入
- node_exporter 数据写入
参数说明
smlAutoCreateDB
:- 设置为
true
时:在 schemaless 协议写入时,如果目标数据库不存在,taosAdapter 会自动创建该数据库。 - 设置为
false
时:用户需要手动创建数据库,否则写入会失败(默认值)。
- 设置为
结果返回条数配置
taosAdapter 提供了参数 restfulRowLimit
,用于控制 HTTP 接口返回的结果条数。
restfulRowLimit
参数只会影响以下接口的返回结果:
- RESTful 接口
- Prometheus remote_read 接口
参数说明
restfulRowLimit
:- 设置为正整数时:接口返回的结果条数将不超过该值。
- 设置为
-1
时:接口返回的结果条数无限制(默认值)。
日志配置
配置参数如下:
-
log.path
指定日志存储路径(默认值:
"/var/log/taos"
)。 -
log.level
设置日志级别(默认值:
"info"
)。 -
log.keepDays
日志保留天数(正整数,默认值:
30
)。 -
log.rotationCount
日志文件轮转数量(默认值:
30
)。 -
log.rotationSize
单个日志文件最大大小(支持 KB/MB/GB 单位,默认值:
"1GB"
)。 -
log.compress
是否压缩旧日志文件(默认值:
false
)。 -
log.rotationTime
日志轮转时间(已弃用,固定 24 小时轮转)。
-
log.reservedDiskSize
为日志目录保留的磁盘空间(支持 KB/MB/GB 单位,默认值:
"1GB"
)。 -
log.enableRecordHttpSql
是否记录 HTTP SQL 请求(默认值:
false
)。 -
log.sqlRotationCount
SQL 日志轮转数量(默认值:
2
)。 -
log.sqlRotationSize
单个 SQL 日志文件最大大小(支持 KB/MB/GB 单位,默认值:
"1GB"
)。 -
log.sqlRotationTime
SQL 日志轮转时间(默认值:
24h
)。
- 可以通过设置 --log.level 参数或者环境变量 TAOS_ADAPTER_LOG_LEVEL 来设置 taosAdapter 日志输出详细程度。有效值包括:panic、fatal、error、warn、warning、info、debug 以及 trace。
- 从 3.3.5.0 版本 开始,taosAdapter 支持通过 HTTP 接口动态修改日志级别。用户可以通过发送 HTTP PUT 请求到 /config 接口,动态调整日志级别。该接口的验证方式与 /rest/sql 接口相同,请求体中需传入 JSON 格式的配置项键值对。
以下是通过 curl 命令将日志级别设置为 debug 的示例:
curl --location --request PUT 'http://127.0.0.1:6041/config' \
-u root:taosdata \
--data '{"log.level": "debug"}'
第三方数据源配置
Collectd 配置参数
-
collectd.enable
启用或禁用 collectd 协议支持(默认值:
false
)。 -
collectd.port
指定 collectd 服务监听端口(默认值:
6045
)。 -
collectd.db
设置 collectd 数据写入的目标数据库名称(默认值:
"collectd"
)。 -
collectd.user
配置连接数据库使用的用户名(默认值:
"root"
)。 -
collectd.password
设置连接数据库使用的密码(默认值:
"taosdata"
)。 -
collectd.ttl
定义 collectd 数据的生存时间(默认值:
0
,表示无超时)。 -
collectd.worker
配置 collectd 写入工作线程数量(默认值:
10
)。
InfluxDB 配置参数
-
influxdb.enable
启用或禁用 InfluxDB 协议支持(布尔值,默认值:
true
)。
node_exporter 配置参数
-
node_exporter.enable
是否启用 node_exporter 数据采集(默认值:
false
)。 -
node_exporter.db
指定 node_exporter 数据写入的数据库名称(默认值:
"node_exporter"
)。 -
node_exporter.urls
配置 node_exporter 服务地址(默认值:
["http://localhost:9100"]
)。 -
node_exporter.gatherDuration
设置数据采集间隔时间(默认值:
5s
)。 -
node_exporter.responseTimeout
配置请求超时时间(默认值:
5s
)。 -
node_exporter.user
设置数据库连接用户名(默认值:
"root"
)。 -
node_exporter.password
设置数据库连接密码(默认值:
"taosdata"
)。 -
node_exporter.ttl
配置采集数据的生存时间(默认值:
0
,表示无超时)。 -
node_exporter.httpUsername
配置 HTTP 基本认证用户名(可选)。
-
node_exporter.httpPassword
配置 HTTP 基本认证密码(可选)。
-
node_exporter.httpBearerTokenString
配置 HTTP Bearer Token 认证(可选)。
-
node_exporter.insecureSkipVerify
是否跳过 SSL 证书验证(默认值:
true
)。 -
node_exporter.certFile
指定客户端证书文件路径(可选)。
-
node_exporter.keyFile
指定客户端证书密钥文件路径(可选)。
-
node_exporter.caCertFile
指定 CA 证书文件路径(可选)。
OpenTSDB 配置参数
-
opentsdb.enable
是否启用 OpenTSDB HTTP 协议支持(默认值:
true
)。 -
opentsdb_telnet.enable
是否启用 OpenTSDB Telnet 协议支持(警告:无认证机制,默认值:
false
)。 -
opentsdb_telnet.ports
配置 OpenTSDB Telnet 监听端口(默认值:
[6046,6047,6048,6049]
)。 -
opentsdb_telnet.dbs
指定 OpenTSDB Telnet 数据写入的数据库(默认值:
["opentsdb_telnet","collectd_tsdb","icinga2_tsdb","tcollector_tsdb"]
)。 -
opentsdb_telnet.user
设置数据库连接用户名(默认值:
"root"
)。 -
opentsdb_telnet.password
设置数据库连接密码(默认值:
"taosdata"
)。 -
opentsdb_telnet.ttl
配置数据生存时间(默认值:
0
,表示无超时)。 -
opentsdb_telnet.batchSize
设置批量写入大小(默认值:
1
)。 -
opentsdb_telnet.flushInterval
配置刷新间隔时间(默认值:
0s
)。 -
opentsdb_telnet.maxTCPConnections
设置最大 TCP 连接数(默认值:
250
)。 -
opentsdb_telnet.tcpKeepAlive
是否启用 TCP KeepAlive(默认值:
false
)。
StatsD 配置参数
-
statsd.enable
是否启用 StatsD 协议支持(默认值:
false
)。 -
statsd.port
设置 StatsD 服务监听端口(默认值:
6044
)。 -
statsd.protocol
指定 StatsD 传输协议(可选:tcp/udp/tcp4/udp4,默认值:
"udp4"
)。 -
statsd.db
配置 StatsD 数据写入的目标数据库(默认值:
"statsd"
)。 -
statsd.user
设置数据库连接用户名(默认值:
"root"
)。 -
statsd.password
设置数据库连接密码(默认值:
"taosdata"
)。 -
statsd.ttl
配置数据生存时间(默认值:
0
,表示无超时)。 -
statsd.gatherInterval
设置数据采集间隔(默认值:
5s
)。 -
statsd.worker
配置写入工作线程数(默认值:
10
)。 -
statsd.allowPendingMessages
设置允许挂起的消息数量(默认值:
50000
)。 -
statsd.maxTCPConnections
配置最大 TCP 连接数(默认值:
250
)。 -
statsd.tcpKeepAlive
是否启用 TCP KeepAlive(默认值:
false
)。 -
statsd.deleteCounters
是否在采集后删除计数器缓存(默认值:
true
)。 -
statsd.deleteGauges
是否在采集后删除测量值缓存(默认值:
true
)。 -
statsd.deleteSets
是否在采集后删除集合缓存(默认值:
true
)。 -
statsd.deleteTimings
是否在采集后删除计时器缓存(默认值:
true
)。
Prometheus 配置参数
-
prometheus.enable
是否启用 Prometheus 协议支持(默认值:
true
)。
上报指标配置
taosAdapter 将指标上报到 taosKeeper 进行统一管理,参数如下:
-
uploadKeeper.enable
是否启用向 taoKeeper 上报监控指标(默认值:
true
)。 -
uploadKeeper.url
配置 taosKeeper 服务地址(默认值:
http://127.0.0.1:6043/adapter_report
)。 -
uploadKeeper.interval
设置上报间隔时间(默认值:
15s
)。 -
uploadKeeper.timeout
配置上报超时时间(默认值:
5s
)。 -
uploadKeeper.retryTimes
设置失败重试次数(默认值:
3
)。 -
uploadKeeper.retryInterval
配置重试间隔时间(默认值:
5s
)。
环境变量
配置项与环境变量对应如下表:
详细信息
服务管理
启动/停止 taosAdapter
在 Linux 系统上 taosAdapter 服务默认由 systemd 管理。使用命令 systemctl start taosadapter
可以启动 taosAdapter 服务。使用命令 systemctl stop taosadapter
可以停止 taosAdapter 服务。使用命令 systemctl status taosadapter
来检查 taosAdapter 运行状态。
升级 taosAdapter
taosAdapter 和 TDengine server 需要使用相同版本。请通过升级 TDengine server 来升级 taosAdapter。 与 taosd 分离部署的 taosAdapter 必须通过升级其所在服务器的 TDengine server 才能得到升级。
移除 taosAdapter
使用命令 rmtaos 可以移除包括 taosAdapter 在内的 TDengine server 软件。
IPv6 支持
taosAdapter 自 3.3.7.0 版本起支持 IPv6,用户无需进行任何额外配置。 taosAdapter 将自动检测系统的 IPv6 支持情况,并在系统支持时自动启用 IPv6,且同时监听 IPv4 和 IPv6 地址。
taosAdapter 监控指标
taosAdapter 目前仅采集 RESTful/WebSocket 相关请求的监控指标,其他接口暂无监控指标。
taosAdapter 将监控指标上报给 taosKeeper,这些监控指标会被 taosKeeper 写入监控数据库,默认是 log
库,可以在 taosKeeper 配置文件中修改。以下是这些监控指标的详细介绍。
adapter_requests
表记录 taosAdapter 监控数据:
详细信息
adapter_status
表记录 taosAdapter 状态数据:
详细信息
adapter_conn_pool
表记录 taosAdapter 连接池监控数据:
详细信息
从 3.3.6.10 版本开始新增 adapter_c_interface
表记录 taosAdapter 调用 C 接口次数数据:
详细信息
httpd 升级为 taosAdapter 的变化
在 TDengine server 2.2.x.x 或更早期版本中,taosd 进程包含一个内嵌的 http 服务(httpd)。如前面所述,taosAdapter 是一个使用 systemd 管理的独立软件,拥有自己的进程。并且两者有一些配置参数和行为是不同的,请见下表:
# | embedded httpd | taosAdapter | comment |
---|---|---|---|
1 | httpEnableRecordSql | --logLevel=debug | |
2 | httpMaxThreads | n/a | taosAdapter 自动管理线程池,无需此参数 |
3 | telegrafUseFieldNum | 请参考 taosAdapter telegraf 配置方法 | |
4 | restfulRowLimit | restfulRowLimit | 内嵌 httpd 默认输出 10240 行数据,最大允许值为 102400。taosAdapter 也提供 restfulRowLimit 但是默认不做限制。您可以根据实际场景需求进行配置 |
5 | httpDebugFlag | 不适用 | httpdDebugFlag 对 taosAdapter 不起作用 |
6 | httpDBNameMandatory | 不适用 | taosAdapter 要求 URL 中必须指定数据库名 |