Project: APISIX (Orchestration & Management / API Gateway)
File: sls-logger.md

title: sls-logger keywords: Apache APISIX API Gateway Plugin SLS Logger Alibaba Cloud Log Service description: This document contains information about the Apache APISIX sls-logger Plugin. <!-- --> The `sls-logger` Plugin is used to push logs to using . It might take some time to receive the log data. It will be automatically sent after the timer function in the expires. | Name | Required | Description | |-|-|-| | host | True | IP address or the hostname of the TCP server. See 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. | | log_format | False | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | | 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. | | accesskeyid | True | AccessKey ID in Alibaba Cloud. See for more details. | | accesskeysecret | True | AccessKey Secret in Alibaba Cloud. See for more details. | | includereqbody | True | When set to `true`, includes the request body in the log. | | includereqbodyexpr | No | Filter for when the `includereq_body` attribute is set to `true`. Request body is only logged when the expression set here evaluates to `true`. See for more. | | includerespbody | No | When set to `true` includes the response body in the log. | | includerespbodyexpr | No | Filter for when the `includeresp_body` attribute is set to `true`. Response body is only logged when the expression set here evaluates to `true`. See for more. | | name | False | Unique identifier for the batch processor. If you use Prometheus to monitor APISIX metrics, the name is exported in `apisixbatchprocess_entries`. | NOTE: `encryptfields = {"accesskey_secret"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See . This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the

The batch processor submits data every `5` seconds or when the data in the queue reaches `1000`. See for more information or setting your custom configuration. ```json { "route_conf": { "host": "100.100.99.135", "buffer_duration": 60, "timeout": 30000, "includereqbody": false, "logstore": "your_logstore", "log_format": { "vip": "$remote_addr" }, "project": "your_project", "inactive_timeout": 5, "accesskeyid": "youraccesskey_id", "accesskeysecret": "youraccesskey_secret", "batchmaxsize": 1000, "maxretrycount": 0, "retry_delay": 1, "port": 10009, "name": "sls-logger" }, "data": "<46>1 2024-01-06T03:29:56.457Z localhost apisix 28063 - [logservice project=\"yourproject\" logstore=\"yourlogstore\" access-key-id=\"youraccesskeyid\" access-key-secret=\"youraccesskeysecret\"] {\"vip\":\"127.0.0.1\",\"route_id\":\"1\"}\n" } ``` You 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 | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | :::info 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: :::note You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash adminkey=$(yq '.deployment.admin.adminkey[0].key' conf/config.yaml | sed 's/"//g') ``` ::: ```shell curl http://127.0.0.1:9180/apisix/admin/pluginmetadata/sls-logger -H "X-API-KEY: $adminkey" -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "clientip": "$remoteaddr" } }' ``` With this configuration, your logs would be formatted as shown below: ```shell {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} ``` The example below shows how you can configure the Plugin on a specific Route: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/5 -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "sls-logger": { "host": "100.100.99.135", "port": 10009, "project": "your_project", "logstore": "your_logstore", "accesskeyid": "youraccesskey_id", "accesskeysecret": "youraccesskey_secret", "timeout": 30000 } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` Now, if you make a request to APISIX, it will be logged in your Ali Cloud log server: ```shell 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: To remove 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. ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }' ```