udp-logger

Description

The udp-logger Plugin can be used to push log data requests to UDP servers.

This provides the ability to send log data requests as JSON objects to monitoring tools and other UDP servers.

This plugin also allows to push logs as a batch to your external UDP server. It might take some time to receive the log data. It will be automatically sent after the timer function in the batch processor expires.

Attributes

NameTypeRequiredDefaultValid valuesDescription
hoststringTrueIP address or the hostname of the UDP server.
portintegerTrue[0,…]Target upstream port.
timeoutintegerFalse3[1,…]Timeout for the upstream to send data.
namestringFalse“udp logger”Unique identifier for the batch processor.
include_req_bodybooleanFalsefalseWhen set to true includes the request body in the log.

This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every 5 seconds or when the data in the queue reaches 1000. See Batch Processor for more information or setting your custom configuration.

Enabling the Plugin

The example below shows how you can enable the Plugin on a specific Route:

  1. curl http://127.0.0.1:9180/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. }'

Example usage

Now, if you make a request to APISIX, it will be logged in your UDP server:

  1. curl -i http://127.0.0.1:9080/hello

Disable Plugin

To disable the udp-logger Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

  1. curl http://127.0.0.1:9180/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. }'