Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve description of name for all logger plugins #10701

Merged
merged 10 commits into from
Dec 25, 2023
Merged

docs: improve description of name for all logger plugins #10701

merged 10 commits into from
Dec 25, 2023

Conversation

zzzk1
Copy link
Contributor

@zzzk1 zzzk1 commented Dec 23, 2023

Description

Fixes #10689
changes:

  • en/skywalking-logger.md
  • zh/skywalking-logger.md
  • en/kafka-logger.md
  • zh/kafka-logger.md
  • en/rocketmq-logger.md
  • zh/rocketmq-logger.md
  • en/udp-logger.md
  • zh/udp-logger.md
  • en/clickhouse-logger.md
  • zh/clickhouse-logger.md
  • en/syslog.md
  • zh/syslog.md
  • en/sls-logger.md
  • zh/sls-logger.md

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@zzzk1
Copy link
Contributor Author

zzzk1 commented Dec 23, 2023

@kayx23, this is my first commit, please check if it meets expectations, I will do next doc.

@kayx23
Copy link
Member

kayx23 commented Dec 23, 2023

The content is ok. The Chinese doc needs some format fixes. Please see the failed CI check. Thanks!

@zzzk1
Copy link
Contributor Author

zzzk1 commented Dec 23, 2023

The content is ok. The Chinese doc needs some format fixes. Please see the failed CI check. Thanks!

I think that's done~

@@ -46,7 +46,7 @@ It might take some time to receive the log data. It will be automatically sent a
| 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. |
| name | False | Unique identifier for the batch processor. If you use Prometheus to monitor APISIX metrics, the name is exported in `apisix_batch_process_entries`. |
Copy link
Member

@kayx23 kayx23 Dec 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it sometimes says "for the batch processor", some other times it's "for the logger" or "to identify the logger"; they should be consistent since they're all for the same purpose.

It is uniquer identifier for the batcher processor of the logger.

@monkeyDluffy6017 monkeyDluffy6017 added the wait for update wait for the author's response in this issue/PR label Dec 25, 2023
Copy link
Member

@kayx23 kayx23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please make the Chinese docs consistent as well? Thanks.

image

@zzzk1
Copy link
Contributor Author

zzzk1 commented Dec 25, 2023

Could you please make the Chinese docs consistent as well? Thanks.

image

Ok I synced names

@kayx23 kayx23 removed wait for update wait for the author's response in this issue/PR user responded labels Dec 25, 2023
@monkeyDluffy6017 monkeyDluffy6017 merged commit 517bf8e into apache:master Dec 25, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: improve description of name for all logger plugins
5 participants