tcp-logger

描述

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

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

属性

名称类型必选项默认值有效值描述
hoststringTCP 服务器的 IP 地址或主机名。
portinteger[0,…]目标端口。
timeoutinteger1000[1,…]发送数据超时间。
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量NGINX 内置变量
tlsbooleanfalse用于控制是否执行 SSL 验证。
tls_optionsstringTLS 选项。
include_req_bodyboolean[false, true]当设置为 true 时,日志中将包含请求体。
include_req_body_exprarrayinclude_req_body 属性设置为 true 时的过滤器。只有当此处设置的表达式求值为 true 时,才会记录请求体。有关更多信息,请参阅 lua-resty-expr
include_resp_bodybooleanfalse[false, true]当设置为 true 时,日志中将包含响应体。
include_resp_body_exprarrayinclude_resp_body 属性设置为 true 时进行过滤响应体,并且只有当此处设置的表达式计算结果为 true 时,才会记录响应体。更多信息,请参考 lua-resty-expr

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

默认日志格式示例

  1. {
  2. "response": {
  3. "status": 200,
  4. "headers": {
  5. "server": "APISIX/3.7.0",
  6. "content-type": "text/plain",
  7. "content-length": "12",
  8. "connection": "close"
  9. },
  10. "size": 118
  11. },
  12. "server": {
  13. "version": "3.7.0",
  14. "hostname": "localhost"
  15. },
  16. "start_time": 1704527628474,
  17. "client_ip": "127.0.0.1",
  18. "service_id": "",
  19. "latency": 102.9999256134,
  20. "apisix_latency": 100.9999256134,
  21. "upstream_latency": 2,
  22. "request": {
  23. "headers": {
  24. "connection": "close",
  25. "host": "localhost"
  26. },
  27. "size": 59,
  28. "method": "GET",
  29. "uri": "/hello",
  30. "url": "http://localhost:1984/hello",
  31. "querystring": {}
  32. },
  33. "upstream": "127.0.0.1:1980",
  34. "route_id": "1"
  35. }

插件元数据

名称类型必选项默认值有效值描述
log_formatobject以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头。则表明获取 APISIX 变量NGINX 内置变量
tcp-logger - 图1注意

该设置全局生效。如果指定了 log_format,则所有绑定 tcp-logger 的路由或服务都将使用该日志格式。

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

tcp-logger - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/tcp-logger \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "log_format": {
  5. "host": "$host",
  6. "@timestamp": "$time_iso8601",
  7. "client_ip": "$remote_addr"
  8. }
  9. }'

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

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

启用插件

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

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -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: $admin_key" -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. }'