sls-logger
#
DescriptionThe sls-logger
Plugin is used to push logs to Alibaba Cloud log Service using RF5424.
It might take some time to receive the log data. It will be automatically sent after the timer function in the batch processor expires.
#
AttributesName | Required | Description |
---|---|---|
host | True | IP address or the hostname of the TCP server. See Alibaba Cloud log service documentation for details. Use IP address instead of domain. |
port | True | Target upstream port. Defaults to 10009 . |
timeout | False | Timeout for the upstream to send data. |
project | True | Project name in Alibaba Cloud log service. Create SLS before using this Plugin. |
logstore | True | logstore name in Ali Cloud log service. Create SLS before using this Plugin. |
access_key_id | True | AccessKey ID in Alibaba Cloud. See Authorization for more details. |
access_key_secret | True | AccessKey Secret in Alibaba Cloud. See Authorization for more details. |
include_req_body | True | When set to true , includes the request body in the log. |
name | False | Unique identifier for the batch processor. |
This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every 5
seconds or when the data in the queue reaches 1000
. See Batch Processor for more information or setting your custom configuration.
#
MetadataYou can also set the format of the logs by configuring the Plugin metadata. The following configurations are available:
Name | Type | Required | Default | Description |
---|---|---|---|---|
log_format | object | False | {"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key value pairs in JSON format. Values only support strings. APISIX or Nginx variables can be used by prefixing the string with $ . |
IMPORTANT
Configuring the Plugin metadata is global in scope. This means that it will take effect on all Routes and Services which use the sls-logger
Plugin.
The example below shows how you can configure through the Admin API:
curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/sls-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"log_format": {
"host": "$host",
"@timestamp": "$time_iso8601",
"client_ip": "$remote_addr"
}
}'
With this configuration, your logs would be formatted as shown below:
{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
#
Enabling the PluginThe example below shows how you can configure the Plugin on 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"
}'
#
Example usageNow, if you make a request to APISIX, it will be logged in your Ali Cloud log server:
curl -i http://127.0.0.1:9080/hello
Now if you check your Ali Cloud log server, you will be able to see the logs:
#
Disable PluginTo disable the sls-logger
Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.
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
}
}
}'