From 8c29339f9e619d128e9b36a66c28827dc042197a Mon Sep 17 00:00:00 2001
From: Navendu Pottekkat <navendupottekkat@gmail.com>
Date: Wed, 22 Jun 2022 07:23:50 +0530
Subject: [PATCH] docs: update "Loggers" Plugin 4/n (#7254)

---
 docs/en/latest/plugins/error-log-logger.md    | 127 ++++++++----------
 .../en/latest/plugins/google-cloud-logging.md |  67 +++++----
 docs/en/latest/plugins/sls-logger.md          |  60 ++++-----
 3 files changed, 121 insertions(+), 133 deletions(-)

diff --git a/docs/en/latest/plugins/error-log-logger.md b/docs/en/latest/plugins/error-log-logger.md
index 57fc5732e4a38..cdcf47a2e5513 100644
--- a/docs/en/latest/plugins/error-log-logger.md
+++ b/docs/en/latest/plugins/error-log-logger.md
@@ -1,7 +1,12 @@
 ---
 title: error-log-logger
+keywords:
+  - APISIX
+  - API Gateway
+  - Plugin
+  - Error log logger
+description: This document contains information about the Apache APISIX error-log-logger Plugin.
 ---
-
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -23,77 +28,53 @@ title: error-log-logger
 
 ## Description
 
-`error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/).
-
-This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers, and SkyWalking over HTTP.
-
-This plugin provides the ability as a batch to push the log data to your external TCP servers or monitoring tools. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor.
+The `error-log-logger` Plugin is used to push APISIX's error logs (`error.log`) to TCP, [Apache SkyWalking](https://skywalking.apache.org/), or ClickHouse servers. You can also set the error log level to send the logs to server.
 
-For more info on Batch-Processor in Apache APISIX please refer.
-[Batch-Processor](../batch-processor.md)
+It might take some time to receive the log data. It will be automatically sent after the timer function in the [batch processor](../batch-processor.md) expires.
 
 ## Attributes
 
-| Name                             | Type    | Requirement | Default                        | Valid   | Description                                                                                          |
-| -------------------------------- | ------- | ----------- | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------- |
-| tcp.host                         | string  | required    |                                |         | IP address or the Hostname of the TCP server.                                                        |
-| tcp.port                         | integer | required    |                                | [0,...] | Target upstream port.                                                                                |
-| tcp.tls                          | boolean | optional    | false                          |         | Control whether to perform SSL verification.                                                         |
-| tcp.tls_server_name              | string  | optional    |                                |         | The server name for the new TLS extension  SNI.                                                      |
-| skywalking.endpoint_addr         | string  | optional   | http://127.0.0.1:12900/v3/logs |         | the http endpoint of Skywalking.                                                                     |
-| skywalking.service_name          | string  | optional    | APISIX                         |         | service name for skywalking reporter                                                                 |
-| skywalking.service_instance_name | String  | optional    | APISIX Instance Name           |         | Service instance name for skywalking reporter, set it to `$hostname` to get local hostname directly. |
-| clickhouse.endpoint_addr         | String  | optional   | http://127.0.0.1:8213          |          |  clickhouse HTTP endpoint, default http://127.0.0.1:8213                    |
-| clickhouse.user                  | String  | optional   | default                        |          |  clickhouse user                                                           |
-| clickhouse.password              | String  | optional   |                                |          |  clickhouse password                                                          |
-| clickhouse.database              | String  | optional   |                                |          |  clickhouse for error log DB name                                             |
-| clickhouse.logtable              | String  | optional   |                                |          |  clickhouse for error log table name                                            |
-| host                             | string  | optional    |                                |         | (`Deprecated`, use `tcp.host` instead) IP address or the Hostname of the TCP server.               |
-| port                             | integer | optional    |                                | [0,...] | (`Deprecated`, use `tcp.port` instead) Target upstream port.                                       |
-| tls                              | boolean | optional    | false                          |         | (`Deprecated`, use `tcp.tls` instead) Control whether to perform SSL verification.                 |
-| tls_server_name                  | string  | optional    |                                |         | (`Deprecated`, use `tcp.tls_server_name` instead) The server name for the new TLS extension SNI.   |
-| timeout                          | integer | optional    | 3                              | [1,...] | Timeout for the upstream to connect and send, unit: second.                                          |
-| keepalive                        | integer | optional    | 30                             | [1,...] | Time for keeping the cosocket alive, unit: second.                                                   |
-| level                            | string  | optional    | WARN                           |         | The filter's log level, default warn, choose the level in ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"], the value ERR equals ERROR.         |
-
-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](../batch-processor.md#configuration) configuration section.
-
-## How To Enable And Disable
-
-The error-log-logger is a global plugin of APISIX.
-
-### Enable plugin
-
-Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine.
-It does not need to be bound in any route or service.
-
-Here is an example of `conf/config.yaml`:
-
-```yaml
-plugins:                          # plugin list
-  ... ...
+| Name                             | Type    | Required | Default                        | Valid values                                                                            | Description                                                                                                  |
+|----------------------------------|---------|----------|--------------------------------|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
+| tcp.host                         | string  | True     |                                |                                                                                         | IP address or the hostname of the TCP server.                                                                |
+| tcp.port                         | integer | True     |                                | [0,...]                                                                                 | Target upstream port.                                                                                        |
+| tcp.tls                          | boolean | False    | false                          |                                                                                         | When set to `true` performs SSL verification.                                                                |
+| tcp.tls_server_name              | string  | False    |                                |                                                                                         | Server name for the new TLS extension SNI.                                                                   |
+| skywalking.endpoint_addr         | string  | False    | http://127.0.0.1:12900/v3/logs |                                                                                         | Apache SkyWalking HTTP endpoint.                                                                             |
+| skywalking.service_name          | string  | False    | APISIX                         |                                                                                         | Service name for the SkyWalking reporter.                                                                    |
+| skywalking.service_instance_name | String  | False    | APISIX Instance Name           |                                                                                         | Service instance name for the SkyWalking reporter. Set it to `$hostname` to directly get the local hostname. |
+| clickhouse.endpoint_addr         | String  | False    | http://127.0.0.1:8213          |                                                                                         | ClickHouse endpoint.                                                                                         |
+| clickhouse.user                  | String  | False    | default                        |                                                                                         | ClickHouse username.                                                                                         |
+| clickhouse.password              | String  | False    |                                |                                                                                         | ClickHouse password.                                                                                         |
+| clickhouse.database              | String  | False    |                                |                                                                                         | Name of the database to store the logs.                                                                      |
+| clickhouse.logtable              | String  | False    |                                |                                                                                         | Table name to store the logs.                                                                                |
+| host                             | string  | False    |                                |                                                                                         | Deprecated. Use `tcp.host` attribute instead. IP address or the hostname of the TCP server.                  |
+| port                             | integer | False    |                                | [0,...]                                                                                 | Deprecated. Use `tcp.port` instead. Target Upstream port.                                                    |
+| tls                              | boolean | False    | false                          |                                                                                         | Deprecated. Use `tcp.tls` instead. When set to `true` performs SSL verification.                             |
+| tls_server_name                  | string  | False    |                                |                                                                                         | Deprecated. Use `tcp.tls_server_name` instead. Server name for the new TLS extension SNI.                    |
+| timeout                          | integer | False    | 3                              | [1,...]                                                                                 | Timeout (in seconds) for the upstream to connect and send data.                                              |
+| keepalive                        | integer | False    | 30                             | [1,...]                                                                                 | Time in seconds to keep the connection alive after sending data.                                             |
+| level                            | string  | False    | WARN                           | ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"] | Log level to filter the error logs. `ERR` is same as `ERROR`.                                                |
+
+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](../batch-processor.md#configuration) for more information or setting your custom configuration.
+
+## Enabling the Plugin
+
+To enable the Plugin, you can add it in your configuration file (`conf/config.yaml`):
+
+```yaml title="conf/config.yaml"
+plugins:
   - request-id
   - hmac-auth
   - api-breaker
-  - error-log-logger              # enable plugin `error-log-logger
+  - error-log-logger
 ```
 
-### Disable plugin
-
-Remove or comment out the plugin `error-log-logger` from `conf/config.yaml`.
-
-```yaml
-plugins:                          # plugin list
-  ... ...
-  - request-id
-  - hmac-auth
-  - api-breaker
-  #- error-log-logger              # enable plugin `error-log-logger
-```
+Once you have enabled the Plugin, you can configure it through the Plugin metadata.
 
-## How to set the TCP server address
+### Configuring TCP server address
 
-Step: update the attributes of the plugin
+You can set the TCP server address by configuring the Plugin metadata as shown below:
 
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -106,9 +87,9 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-A
 }'
 ```
 
-## How to set the SkyWalking OAP server address
+### Configuring SkyWalking OAP server address
 
-Step: update the attributes of the plugin
+You can configure the SkyWalking OAP server address as shown below:
 
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -120,13 +101,11 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-A
 }'
 ```
 
-## How to set the clickhouse
+### Configuring ClickHouse server details
 
-The plugin sends the error log as a string to the `data` field of the clickhouse table.
+The Plugin sends the error log as a string to the `data` field of a table in your ClickHouse server.
 
-*TODO Here save error log as a whole string to clickhouse 'data' column. We will add more columns in the future.*
-
-Step: update the attributes of the plugin
+You can configure it as shown below:
 
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -140,3 +119,15 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/error-log-logger -H 'X-A
   }
 }'
 ```
+
+## Disable Plugin
+
+To disable the Plugin, you can remove it from your configuration file (`conf/config.yaml`):
+
+```yaml title="conf/config.yaml"
+plugins:
+  - request-id
+  - hmac-auth
+  - api-breaker
+  # - error-log-logger
+```
diff --git a/docs/en/latest/plugins/google-cloud-logging.md b/docs/en/latest/plugins/google-cloud-logging.md
index 94e3165dd2b50..19c98bbc750e6 100644
--- a/docs/en/latest/plugins/google-cloud-logging.md
+++ b/docs/en/latest/plugins/google-cloud-logging.md
@@ -1,7 +1,12 @@
 ---
 title: google-cloud-logging
+keywords:
+  - APISIX
+  - API Gateway
+  - Plugin
+  - Google Cloud logging
+description: This document contains information about the Apache APISIX google-cloud-logging Plugin.
 ---
-
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -23,36 +28,33 @@ title: google-cloud-logging
 
 ## Description
 
-`google-cloud-logging` plugin is used to send the access log of `Apache APISIX` to the [Google Cloud Logging Service](https://cloud.google.com/logging/).
-
-This plugin provides the ability to push log data as a batch to Google Cloud logging Service.
+The `google-cloud-logging` Plugin is used to send APISIX access logs to [Google Cloud Logging Service](https://cloud.google.com/logging/).
 
-For more info on Batch-Processor in Apache APISIX please refer:
-[Batch-Processor](../batch-processor.md)
+This plugin also allows to push logs as a batch to your Google Cloud Logging Service. It might take some time to receive the log data. It will be automatically sent after the timer function in the [batch processor](../batch-processor.md) expires.
 
 ## Attributes
 
-| Name                    | Requirement   | Default                                                                                                                                                                                           | Description                                                                                                                                                                      |
-| ----------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| auth_config             | Semi-optional |                                                                                                                                                                                                   | one of `auth_config` or `auth_file` must be configured                                                                                                                           |
-| auth_config.private_key | required      |                                                                                                                                                                                                   | the private key parameters of the Google service account                                                                                                                         |
-| auth_config.project_id  | required      |                                                                                                                                                                                                   | the project id parameters of the Google service account                                                                                                                          |
-| auth_config.token_uri   | optional      | https://oauth2.googleapis.com/token                                                                                                                                                               | the token uri parameters of the Google service account                                                                                                                           |
-| auth_config.entries_uri | optional      | https://logging.googleapis.com/v2/entries:write                                                                                                                                                   | google cloud logging service API                                                                                                                                                       |
-| auth_config.scopes      | optional      | ["https://www.googleapis.com/auth/logging.read","https://www.googleapis.com/auth/logging.write","https://www.googleapis.com/auth/logging.admin","https://www.googleapis.com/auth/cloud-platform"] | the access scopes parameters of the Google service account, refer to: [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes#logging) |
-| auth_file               | semi-optional |                                                                                                                                                                                                   | path to the google service account json file（Semi-optional, one of auth_config or auth_file must be configured）                                                              |
-| ssl_verify              | optional      | true                                                                                                                                                                                              | enable `SSL` verification, option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake)                                                    |
-| resource                | optional      | {"type": "global"}                                                                                                                                                                                | the Google monitor resource, refer to: [MonitoredResource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource)                                         |
-| log_id                  | optional      | apisix.apache.org%2Flogs                                                                                                                                                                          | google cloud logging id, refer to: [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)                                                                     |
+| Name                    | Required | Default                                                                                                                                                                                              | Description                                                                                                                                                        |
+|-------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| auth_config             | True     |                                                                                                                                                                                                      | Either `auth_config` or `auth_file` must be provided.                                                                                                              |
+| auth_config.private_key | True     |                                                                                                                                                                                                      | Private key of the Google Cloud service account.                                                                                                                   |
+| auth_config.project_id  | True     |                                                                                                                                                                                                      | Project ID in the Google Cloud service account.                                                                                                                    |
+| auth_config.token_uri   | False    | https://oauth2.googleapis.com/token                                                                                                                                                                  | Token URI of the Google Cloud service account.                                                                                                                     |
+| auth_config.entries_uri | False    | https://logging.googleapis.com/v2/entries:write                                                                                                                                                      | Google Cloud Logging Service API.                                                                                                                                  |
+| auth_config.scopes      | False    | ["https://www.googleapis.com/auth/logging.read", "https://www.googleapis.com/auth/logging.write", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/cloud-platform"] | Access scopes of the Google Cloud service account. See [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes#logging). |
+| auth_file               | True     |                                                                                                                                                                                                      | Path to the Google Cloud service account authentication JSON file. Either `auth_config` or `auth_file` must be provided.                                           |
+| ssl_verify              | False    | true                                                                                                                                                                                                 | When set to `true`, enables SSL verification as mentioned in [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake).                  |
+| resource                | False    | {"type": "global"}                                                                                                                                                                                   | Google monitor resource. See [MonitoredResource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource) for more details.                   |
+| log_id                  | False    | apisix.apache.org%2Flogs                                                                                                                                                                             | Google Cloud logging ID. See [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) for details.                                          |
 
-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](../batch-processor.md#configuration) configuration section.
+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](../batch-processor.md#configuration) for more information or setting your custom configuration.
 
-## How To Enable
-
-The following is an example of how to enable the `google-cloud-logging` for a specific route.
+## Enabling the Plugin
 
 ### Full configuration
 
+The example below shows a complete configuration of the Plugin on a specific Route:
+
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
@@ -88,7 +90,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
 }'
 ```
 
-### Minimize configuration
+### Minimal configuration
+
+The example below shows a bare minimum configuration of the Plugin on a Route:
 
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -111,27 +115,22 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
 }'
 ```
 
-## Test Plugin
+## Example usage
 
-* Send request to route configured with the `google-cloud-logging` plugin
+Now, if you make a request to APISIX, it will be logged in your Google Cloud Logging Service.
 
 ```shell
-$ curl -i http://127.0.0.1:9080/hello
-HTTP/1.1 200 OK
-...
-hello, world
+curl -i http://127.0.0.1:9080/hello
 ```
 
-* Login to Google Cloud to view logging service
-
-[Google Cloud Logging Service](https://console.cloud.google.com/logs/viewer)
+You can then login and view the logs in [Google Cloud Logging Service](https://console.cloud.google.com/logs/viewer).
 
 ## Disable Plugin
 
-Disabling the `google-cloud-logging` plugin is very simple, just remove the `JSON` configuration corresponding to `google-cloud-logging`.
+To disable the `google-cloud-logging` 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:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "uri": "/hello",
     "plugins": {},
diff --git a/docs/en/latest/plugins/sls-logger.md b/docs/en/latest/plugins/sls-logger.md
index 8b4a90737f292..1762f9271f335 100644
--- a/docs/en/latest/plugins/sls-logger.md
+++ b/docs/en/latest/plugins/sls-logger.md
@@ -1,7 +1,13 @@
 ---
 title: sls-logger
+keywords:
+  - APISIX
+  - API Gateway
+  - Plugin
+  - SLS Logger
+  - Alibaba Cloud Log Service
+description: This document contains information about the Apache APISIX sls-logger Plugin.
 ---
-
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -23,32 +29,29 @@ title: sls-logger
 
 ## Description
 
-`sls-logger` is a plugin which push Log data requests to ali cloud [Log Server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) with  [RF5424](https://tools.ietf.org/html/rfc5424).
-
-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.
+The `sls-logger` Plugin is used to push logs to [Alibaba Cloud log Service](https://www.alibabacloud.com/help/en/log-service/latest/use-the-syslog-protocol-to-upload-logs) using [RF5424](https://tools.ietf.org/html/rfc5424).
 
-For more info on Batch-Processor in Apache APISIX please refer
-[Batch-Processor](../batch-processor.md)
+It might take some time to receive the log data. It will be automatically sent after the timer function in the [batch processor](../batch-processor.md) expires.
 
 ## Attributes
 
-|Name           |Requirement    |Description|
-|---------      |--------       |-----------|
-|host           |required       | IP address or the Hostname of the TCP server, please reference ali cloud log [Serve List](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb), use IP address instead of domain.|
-|port           |required       |Target upstream port, default 10009.|
-|timeout        |optional       |Timeout for the upstream to send data.|
-| project |required|Ali cloud log service project name，please create in sls before us this plugin.|
-| logstore | required |Ali cloud log service  logstore name，please create in sls before us this plugin.|
-| access_key_id | required | Ali cloud AccessKey ID, reference [Authorization](https://help.aliyun.com/document_detail/47664.html?spm=a2c4g.11186623.2.15.49301b47lfvxXP#task-xsk-ttc-ry).|
-| access_key_secret | required |Ali cloud AccessKey Secret, reference [Authorization](https://help.aliyun.com/document_detail/47664.html?spm=a2c4g.11186623.2.15.49301b47lfvxXP#task-xsk-ttc-ry).|
-| include_req_body | required| Boolean value. |
-|name           |optional       |A unique identifier to identity the batch processor.|
+| Name              | Required | Description                                                                                                                                                                                                                                     |
+|-------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| host              | True     | IP address or the hostname of the TCP server. See [Alibaba Cloud log service documentation](https://www.alibabacloud.com/help/en/log-service/latest/endpoints) 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](https://www.alibabacloud.com/help/en/log-service/latest/create-a-ram-user-and-authorize-the-ram-user-to-access-log-service) for more details.                                                                     |
+| access_key_secret | True     | AccessKey Secret in Alibaba Cloud. See [Authorization](https://www.alibabacloud.com/help/en/log-service/latest/create-a-ram-user-and-authorize-the-ram-user-to-access-log-service) 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.                                                                                                                                                                                                      |
 
-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](../batch-processor.md#configuration) configuration section.
+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](../batch-processor.md#configuration) for more information or setting your custom configuration.
 
-## How To Enable
+## Enabling the Plugin
 
-The following is an example on how to enable the sls-logger for a specific route.
+The example below shows how you can configure the Plugin on a specific Route:
 
 ```shell
 curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -72,31 +75,26 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
     },
     "uri": "/hello"
 }'
-
 ```
 
-## Test Plugin
+## Example usage
 
-* success:
+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
-HTTP/1.1 200 OK
-...
-hello, world
+curl -i http://127.0.0.1:9080/hello
 ```
 
-* check log in ali cloud log service
+Now if you check your Ali Cloud log server, you will be able to see the logs:
 
 ![sls logger view](../../../assets/images/plugin/sls-logger-1.png "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.
+To 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.
 
 ```shell
-$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 {
     "uri": "/hello",
     "plugins": {},