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.

Attributes

Name	Requirement	Description
host	required	IP address or the Hostname of the TCP server.
port	required	Target upstream port.
timeout	optional	Timeout for the upstream to send data.
tls	optional	Boolean value to control whether to perform SSL verification
tls_options	optional	tls options

How To Enable

Here is an examle on how to enable tcp-logger plugin for a specific route.

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

Test Plugin

success:

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

Disable Plugin

When you want to disable the tcp-logger plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately:

$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

2.8 KiB Raw Blame History