tcp-logger

该插件还实现了将日志数据以 JSON 格式发送到监控工具或其它 TCP 服务的能力。

属性

该插件支持使用批处理器来聚合并批量处理条目（日志/数据）。这样可以避免插件频繁地提交数据，默认情况下批处理器每 5 秒钟或队列中的数据达到 1000 条时提交数据，如需了解批处理器相关参数设置，请参考 Batch-Processor。

名称类型必选项默认值有效值描述
log_formatobject否{“host”: “$host”, “@timestamp”: “$time_iso8601”, “client_ip”: “$remote_addr”}以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头。则表明获取 APISIX 变量 或 。
注意

以下示例展示了如何通过 Admin API 配置插件元数据：

配置完成后，你将在日志系统中看到如下类似日志：

  1. {"@timestamp":"2023-01-09T14:47:25+08:00","route_id":"1","host":"localhost","client_ip":"127.0.0.1"}

启用插件

现在你可以向 APISIX 发起请求：

  1. curl -i http://127.0.0.1:9080/hello

禁用插件

当你需要禁用该插件时，可通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "plugins": {},
  6.     "upstream": {
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:1980": 1
  10.         }
  11. }'