Skip to main content
Version: 2.11




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.

This plugin provides the ability to push Log data as a batch to you're external UDP servers. In case if you did not receive the log data don't worry give it some time it will automatically send the logs after the timer function expires in our Batch Processor.

For more info on Batch-Processor in Apache APISIX please refer. Batch-Processor


hoststringrequiredIP address or the Hostname of the UDP server.
portintegerrequired[0,...]Target upstream port.
timeoutintegeroptional3[1,...]Timeout for the upstream to send data.
namestringoptional"udp logger"A unique identifier to identity the batch processor
batch_max_sizeintegeroptional1000[1,...]Max size of each batch
inactive_timeoutintegeroptional5[1,...]Maximum age in seconds when the buffer will be flushed if inactive
buffer_durationintegeroptional60[1,...]Maximum age in seconds of the oldest entry in a batch before the batch must be processed
include_req_bodybooleanoptionalfalseWhether to include the request body

How To Enable#

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

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{      "plugins": {            "udp-logger": {                 "host": "",                 "port": 3000,                 "batch_max_size": 1,                 "name": "udp logger"            }       },      "upstream": {           "type": "roundrobin",           "nodes": {               "": 1           }      },      "uri": "/hello"}'

Test Plugin#

  • success:
$ curl -i 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "": 1        }    }}'