udp-logger

描述

udp-logger 是用于将日志数据发送到 UDP 服务的插件。

以实现将日志数据以 JSON 格式发送到监控工具或其它 UDP 服务的能力。

此插件提供了将批处理数据批量推送到外部 UDP 服务器的功能。如果您没有收到日志数据，请放心一些时间，它会在我们的批处理处理器中的计时器功能到期后自动发送日志

有关 Apache APISIX 中 Batch-Processor 的更多信息，请参考： Batch-Processor

属性列表

名称类型必选项默认值有效值描述
hoststring必须UDP 服务的 IP 地址或主机名
portinteger必须[0,…]目标端口
timeoutinteger可选1000[1,…]发送数据超时间
namestring可选“udp logger”用于识别批处理器
include_req_bodyboolean可选是否包括请求 body

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

如何开启

  1. 下面例子展示了如何为指定路由开启 udp-logger 插件的。
  1. curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.       "plugins": {
  4.             "udp-logger": {
  5.                  "host": "127.0.0.1",
  6.                  "port": 3000,
  7.                  "batch_max_size": 1,
  8.                  "name": "udp logger"
  9.             }
  10.        },
  11.       "upstream": {
  12.            "type": "roundrobin",
  13.            "nodes": {
  14.                "127.0.0.1:1980": 1
  15.            }
  16.       },
  17.       "uri": "/hello"
  18. }'

测试插件

  • 成功的情况:
  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. hello, world

禁用插件

想要禁用“udp-logger”插件，是非常简单的，将对应的插件配置从 json 配置删除，就会立即生效，不需要重新启动服务：

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