Summary

Name
Attributes
How To Enable
Test Plugin
Disable Plugin

Name

udp-logger is a plugin which push Log data requests to UDP servers.

This will provide the ability to send Log data requests as JSON objects to Monitoring tools and other UDP servers.

Attributes

Name	Requirement	Description
host	required	IP address or the Hostname of the UDP server.
port	required	Target upstream port.
timeout	optional	Timeout for the upstream to send data.
name	optional	A unique identifier to identity the batch processor
batch_max_size	optional	Max size of each batch, default is 1000
inactive_timeout	optional	Maximum age in seconds when the buffer will be flushed if inactive, default is 5s
buffer_duration	optional	Maximum age in seconds of the oldest entry in a batch before the batch must be processed, default is 60

How To Enable

The following is an example on how to enable the udp-logger for a specific route.

curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "username": "foo",
    "plugins": {
          "plugins": {
                "udp-logger": {
                     "host": "127.0.0.1",
                     "port": 3000,
                     "batch_max_size": 1,
                     "name": "udp logger"
                }
           },
          "upstream": {
               "type": "roundrobin",
               "nodes": {
                   "127.0.0.1:1980": 1
               }
          },
          "uri": "/hello"
    }
}'

Test Plugin

success:

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

Disable Plugin

Remove the corresponding json configuration in the plugin configuration to disable the udp-logger. APISIX plugins are hot-reloaded, therefore no need to restart APISIX.

$ 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
        }
    }
}'

3.1 KiB Raw Blame History