You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/06/15 06:33:25 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request, #7254: docs: update "Loggers" Plugin 4/n
navendu-pottekkat opened a new pull request, #7254:
URL: https://github.com/apache/apisix/pull/7254
Signed-off-by: Navendu Pottekkat <na...@gmail.com>
### Description
Updates the documentation of the "Observability/Loggers" Plugins (4/n).
Child PR of #6734
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #7254: docs: update "Loggers" Plugin 4/n
Posted by GitBox <gi...@apache.org>.
spacewander merged PR #7254:
URL: https://github.com/apache/apisix/pull/7254
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a diff in pull request #7254: docs: update "Loggers" Plugin 4/n
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7254:
URL: https://github.com/apache/apisix/pull/7254#discussion_r899182191
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -1,7 +1,13 @@
---
title: sls-logger
+keywords:
+ - APISIX
+ - API Gateway
+ - Plugin
+ - SLS Logger
+ - Ali Cloud Log Server
Review Comment:
```suggestion
- Alibaba Cloud Log Service
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) using [RF5424](https://tools.ietf.org/html/rfc5424).
Review Comment:
```suggestion
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).
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) 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 [Ali Cloud log documentation](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb) 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 Ali Cloud log service. Create SLS before using this Plugin. |
Review Comment:
```suggestion
| project | True | Project name in Alibaba Cloud Log Service. Create SLS before using this Plugin. |
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) 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 [Ali Cloud log documentation](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb) for details. Use IP address instead of domain. |
Review Comment:
```suggestion
| host | True | IP address or the hostname of the TCP server. See [Alibaba Cloud Log Service](https://www.alibabacloud.com/help/en/log-service/latest/endpoints) for details. Use IP address instead of domain. |
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) 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 [Ali Cloud log documentation](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb) 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 Ali 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 Ali Cloud. See [Authorization](https://help.aliyun.com/document_detail/47664.html?spm=a2c4g.11186623.2.15.49301b47lfvxXP#task-xsk-ttc-ry) for more details. |
Review Comment:
```suggestion
| 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. |
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -1,7 +1,13 @@
---
title: sls-logger
+keywords:
+ - APISIX
+ - API Gateway
+ - Plugin
+ - SLS Logger
+ - Ali Cloud Log Server
Review Comment:
Others also need to be modified.
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -1,7 +1,13 @@
---
title: sls-logger
+keywords:
+ - APISIX
+ - API Gateway
+ - Plugin
+ - SLS Logger
+ - Ali Cloud Log Server
Review Comment:
please refer: https://www.alibabacloud.com/product/log-service
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) 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 [Ali Cloud log documentation](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb) 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 Ali 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 Ali Cloud. See [Authorization](https://help.aliyun.com/document_detail/47664.html?spm=a2c4g.11186623.2.15.49301b47lfvxXP#task-xsk-ttc-ry) for more details. |
+| access_key_secret | True | AccessKey Secret in Ali Cloud. See [Authorization](https://help.aliyun.com/document_detail/47664.html?spm=a2c4g.11186623.2.15.49301b47lfvxXP#task-xsk-ttc-ry) for more details. |
Review Comment:
```suggestion
| access_key_secret | True | AccessKey Secret in Ali 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. |
```
##########
docs/en/latest/plugins/sls-logger.md:
##########
@@ -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 [Ali Cloud log server](https://help.aliyun.com/document_detail/112903.html?spm=a2c4g.11186623.6.763.21321b47wcwt1u) 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 [Ali Cloud log documentation](https://help.aliyun.com/document_detail/29008.html?spm=a2c4g.11186623.2.14.49301b4793uX0z#reference-wgx-pwq-zdb) for details. Use IP address instead of domain. |
Review Comment:
We should use English documentation links.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on pull request #7254: docs: update "Loggers" Plugin 4/n
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #7254:
URL: https://github.com/apache/apisix/pull/7254#issuecomment-1156583054
@juzhiyuan Updated keywords here as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org