1 Star 0 Fork 166

silence_war / Apache APISIX incubating

forked from iresty / Apache APISIX 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
tcp-logger.md 3.77 KB
一键复制 编辑 原始数据 按行查看 历史

Summary

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 you're external TCP servers. In case if you did not recieve 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 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
name optional A unique identifier to identity the batch processor
batch_max_size optional Max size of each batch, default is 1000
inactive_timeout optional maximum age in seconds when the buffer will be flushed if inactive, default is 5s
buffer_duration optional Maximum age in seconds of the oldest entry in a batch before the batch must be processed, default is 5
max_retry_count optional Maximum number of retries before removing from the processing pipe line; default is zero
retry_delay optional Number of seconds the process execution should be delayed if the execution fails; default is 1

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/hello
HTTP/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:2379/apisix/admin/routes/1 -X PUT -d value='
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'
Lua
1
https://gitee.com/silence_war/apisix.git
git@gitee.com:silence_war/apisix.git
silence_war
apisix
Apache APISIX incubating
master

搜索帮助