udp-logger

Description

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

Attributes

NameTypeRequirementDefaultValidDescription
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
include_req_bodybooleanoptionalfalseWhether to include the request body

The plugin supports the use of batch processors to aggregate and process entries(logs/data) in a batch. This avoids frequent data submissions by the plugin, which by default the batch processor submits data every 5 seconds or when the data in the queue reaches 1000. For information or custom batch processor parameter settings, see Batch-Processor configuration section.

How To Enable

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

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

Test Plugin

  • success:
  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. 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.

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