docs: update "Loggers" Plugin 4/n #7254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
|
@juzhiyuan Updated keywords here as well. |
juzhiyuan
previously approved these changes
Jun 16, 2022
guitu168
reviewed
Jun 16, 2022
docs/en/latest/plugins/sls-logger.md
Outdated
| - API Gateway | ||
| - Plugin | ||
| - SLS Logger | ||
| - Ali Cloud Log Server |
There was a problem hiding this comment.
Suggested change
| - Ali Cloud Log Server | |
| - Alibaba Cloud Log Service |
There was a problem hiding this comment.
please refer: https://www.alibabacloud.com/product/log-service
There was a problem hiding this comment.
Others also need to be modified.
docs/en/latest/plugins/sls-logger.md
Outdated
| `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). |
There was a problem hiding this comment.
Suggested change
| 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). | |
| 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
Outdated
| |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. | |
There was a problem hiding this comment.
Suggested change
| | 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. | | |
| | 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. | |
There was a problem hiding this comment.
We should use English documentation links.
docs/en/latest/plugins/sls-logger.md
Outdated
| | 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. | |
There was a problem hiding this comment.
Suggested change
| | project | True | Project name in Ali Cloud log service. Create SLS before using this Plugin. | | |
| | project | True | Project name in Alibaba Cloud Log Service. Create SLS before using this Plugin. | |
docs/en/latest/plugins/sls-logger.md
Outdated
| | 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. | |
There was a problem hiding this comment.
Suggested change
| | 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_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
Outdated
| | 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. | |
There was a problem hiding this comment.
Suggested change
| | 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. | | |
| | 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. | |
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
juzhiyuan
approved these changes
Jun 20, 2022
SylviaBABY
approved these changes
Jun 21, 2022
spacewander
pushed a commit
that referenced
this pull request
Jun 30, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
Nov 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com
Description
Updates the documentation of the "Observability/Loggers" Plugins (4/n).
Child PR of #6734