tcp-logger

描述

tcp-logger 插件可用于将日志数据发送到 TCP 服务器。

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

属性

名称类型必选项默认值有效值描述
hoststring是TCP 服务器的 IP 地址或主机名。
portinteger是[0,…]目标端口。
timeoutinteger否1000[1,…]发送数据超时间。
tlsboolean否false用于控制是否执行 SSL 验证。
tls_optionsstring否TLS 选项。
include_req_bodyboolean否当设置为 true 时，日志中将包含请求体。

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

启用插件

你可以通过以下命令在指定路由中启用该插件：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.       "plugins": {
  5.             "tcp-logger": {
  6.                  "host": "127.0.0.1",
  7.                  "port": 5044,
  8.                  "tls": false,
  9.                  "batch_max_size": 1,
  10.                  "name": "tcp logger"
  11.             }
  12.        },
  13.       "upstream": {
  14.            "type": "roundrobin",
  15.            "nodes": {
  16.                "127.0.0.1:1980": 1
  17.            }
  18.       },
  19.       "uri": "/hello"
  20. }'

测试插件

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

  1. curl -i http://127.0.0.1:9080/hello
  1. HTTP/1.1 200 OK
  2. ...
  3. hello, world

禁用插件

当你需要禁用该插件时，可通过以下命令删除相应的 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.     "uri": "/hello",
  6.     "plugins": {},
  7.     "upstream": {
  8.         "type": "roundrobin",
  9.         "nodes": {
  10.             "127.0.0.1:1980": 1
  11.         }
  12.     }
  13. }'