Skip to main content
Version: 2.14



sys is a plugin which push Log data requests to Syslog.

This will provide the ability to send Log data requests as JSON objects.


hoststringrequiredIP address or the Hostname.
portintegerrequiredTarget upstream port.
namestringoptional"sys logger"
timeoutintegeroptional3000[1, ...]Timeout for the upstream to send data (unit: ms).
tlsbooleanoptionalfalseControl whether to perform SSL verification
flush_limitintegeroptional4096[1, ...]If the buffered messages' size plus the current message size reaches (>=) this limit (in bytes), the buffered log messages will be written to log server. Default to 4096 (4KB).
drop_limitintegeroptional1048576If the buffered messages' size plus the current message size is larger than this limit (in bytes), the current log message will be dropped because of limited buffer size. Default to 1048576 (1MB).
sock_typestringoptional"tcp"["tcp", "udp]IP protocol type to use for transport layer.
max_retry_timesintegeroptional[1, ...]Deprecated. Use max_retry_count instead. Max number of retry times after a connect to a log server failed or send log messages to a log server failed.
retry_intervalintegeroptional[0, ...]Deprecated. Use retry_delay instead. The time delay (in ms) before retry to connect to a log server or retry to send log messages to a log server
pool_sizeintegeroptional5[5, ...]Keepalive pool size used by sock:keepalive.
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 sys-logger for a specific route.

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"plugins": {
"syslog": {
"host" : "",
"port" : 5044,
"flush_limit" : 1
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1
"uri": "/hello"

Test Plugin#

  • success:
$ curl -i
HTTP/1.1 200 OK
hello, world

Disable Plugin#

Remove the corresponding json configuration in the plugin configuration to disable the sys-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