Skip to main content
Version: Next

sls-logger

Description#

sls-logger is a plugin which push Log data requests to ali cloud Log Server with RF5424.

This plugin provides the ability to push Log data as a batch to ali cloud log service. 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#

NameRequirementDescription
hostrequiredIP address or the Hostname of the TCP server, please reference ali cloud log Serve List, use IP address instead of domain.
portrequiredTarget upstream port, default 10009.
timeoutoptionalTimeout for the upstream to send data.
projectrequiredAli cloud log service project name,please create in sls before us this plugin.
logstorerequiredAli cloud log service logstore name,please create in sls before us this plugin.
access_key_idrequiredAli cloud AccessKey ID, reference Authorization.
access_key_secretrequiredAli cloud AccessKey Secret, reference Authorization.
include_req_bodyrequiredBoolean value.
nameoptionalA unique identifier to identity the batch processor.

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 sls-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": {        "sls-logger": {            "host": "100.100.99.135",            "port": 10009,            "project": "your_project",            "logstore": "your_logstore",            "access_key_id": "your_access_key_id",            "access_key_secret": "your_access_key_secret",            "timeout": 30000        }    },    "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
  • check log in ali cloud log service

sls logger view

Disable Plugin#

Remove the corresponding json configuration in the plugin configuration to disable the sls-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 '{    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1980": 1        }    }}'