apisix/doc/plugins/udp-logger-cn.md

2.8 KiB
Raw Blame History

摘要

定义

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

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

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

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

属性列表

属性名称 必选项 描述
host 必要的 UDP 服务的IP地址或主机名。
port 必要的 目标端口。
timeout 可选的 发送数据超时间。

如何开启

  1. 下面例子展示了如何为指定路由开启 udp-logger 插件的。
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
      "plugins": {
            "tcp-logger": {
                 "host": "127.0.0.1",
                 "port": 5044,
                 "tls": false
            }
       },
      "upstream": {
           "type": "roundrobin",
           "nodes": {
               "127.0.0.1:1980": 1
           }
      },
      "uri": "/hello"
}'

测试插件

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

禁用插件

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

$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'