Version: Next

tcp-logger

Summary#

Name
Attributes
How To Enable
Test Plugin
Disable Plugin

Name#

tcp-logger is a plugin which push Log data requests to TCP servers.

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

This plugin provides the ability to push Log data as a batch to your external TCP 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#

Name	Type	Requirement	Default	Valid	Description
host	string	required			IP address or the Hostname of the TCP server.
port	integer	required		[0,...]	Target upstream port.
timeout	integer	optional	1000	[1,...]	Timeout for the upstream to send data.
tls	boolean	optional	false		Control whether to perform SSL verification
tls_options	string	optional			tls options
batch_max_size	integer	optional	1000	[1,...]	Max size of each batch
inactive_timeout	integer	optional	5	[1,...]	Maximum age in seconds when the buffer will be flushed if inactive
buffer_duration	integer	optional	60	[1,...]	Maximum age in seconds of the oldest entry in a batch before the batch must be processed
max_retry_count	integer	optional	0	[0,...]	Maximum number of retries before removing from the processing pipe line
retry_delay	integer	optional	1	[0,...]	Number of seconds the process execution should be delayed if the execution fails
include_req_body	boolean	optional	false		Whether to include the request body

How To Enable#

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

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{      "plugins": {            "tcp-logger": {                 "host": "127.0.0.1",                 "port": 5044,                 "tls": false,                 "batch_max_size": 1,                 "name": "tcp logger"            }       },      "upstream": {           "type": "roundrobin",           "nodes": {               "127.0.0.1:1980": 1           }      },      "uri": "/hello"}'

Test Plugin#

success:

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

Disable Plugin#

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

$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1980": 1        }    }}'