SylviaBABY commented on code in PR #7528:
URL: https://github.com/apache/apisix/pull/7528#discussion_r930531808
##########
docs/en/latest/plugins/http-logger.md:
##########
@@ -2,10 +2,10 @@
title: http-logger
keywords:
- APISIX
+ - API 网关
- Plugin
- HTTP Logger
- - http-logger
-description: This document contains information about the Apache APISIX
http-logger Plugin.
+description: This document contains information about the Apache APISIX
http-logger Plugin, Using this Plugin, you can push APISIX log data to HTTP or
HTTPS servers.
Review Comment:
```suggestion
description: This document contains information about the Apache APISIX
http-logger Plugin. Using this Plugin, you can push APISIX log data to HTTP or
HTTPS servers.
```
##########
docs/zh/latest/plugins/http-logger.md:
##########
@@ -23,32 +31,68 @@ title: http-logger
## 描述
-`http-logger` 是一个插件，可将 Log 数据请求推送到 HTTP / HTTPS 服务器。
-
-这将提供将 Log 数据请求作为 JSON 对象发送到监视工具和其他 HTTP 服务器的功能。
+`http-logger`插件可以将 APISIX 的日志数据推送到 HTTP 或 HTTPS 服务器。该插件提供了将日志数据请求作为 JSON
对象发送到监控工具或者其他 HTTP 服务器的功能。
## 属性
+| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述
|
+| ---------------------- | ------- | ------ | ------------- |
-------------------- | ------------------------------------------------ |
+| uri | string | 是 | |
| HTTP 或 HTTPS 服务器的 URI。 |
+| auth_header | string | 否 | "" |
| 授权 header（如果需要）。 |
+| timeout | integer | 否 | 3 | [1,...]
| 发送请求后保持连接处于活动状态的时间。 |
+| name | string | 否 | "http logger" |
| 标识 logger 的唯一标识符。 |
+| include_req_body | boolean | 否 | false | [false, true]
| 当设置为 `true` 时，将请求体包含在日志中。如果请求体太大而无法保存在内存中，由于 NGINX 的限制，无法记录。 |
+| include_resp_body | boolean | 否 | false | [false, true]
| 当设置为 `true` 时，包含响应体。
|
+| include_resp_body_expr | array | 否 | |
| 当 `include_resp_body` 属性设置为 `true` 时，使用该属性并基于
[lua-resty-expr](https://github.com/api7/lua-resty-expr) 进行过滤。 如果存在，则仅在表达式计算结果为
`true` 时记录响应。 |
+| concat_method | string | 否 | "json" | ["json",
"new_line"] | 枚举类型： **json**：对所有待发日志使用 `json.encode`
编码。**new_line**：对每一条待发日志单独使用 `json.encode` 编码并使用 `\n` 连接起来。 |
+| ssl_verify | boolean | 否 | false | [false, true]
| 当设置为 `true` 时验证证书。 |
+
+:::note 注意
+
+本插件支持使用批处理器来聚合并批量处理条目（日志和数据）。这样可以避免该插件频繁地提交数据。默认情况下每 `5` 秒钟或队列中的数据达到 `1000`
条时，批处理器会自动提交数据，如需了解更多信息或自定义配置，请参考 [Batch Processor](../batch-processor.md#配置)。
+
+:::
+
+## 插件元数据
+
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述
|
| ---------------- | ------- | ------ | ------------- | ------- |
------------------------------------------------ |
-| uri | string | 必须 | | | `HTTP/HTTPS`
服务器的 URI。 |
-| auth_header | string | 可选 | | | 授权头部。
|
-| timeout | integer | 可选 | 3 | [1,...] |
发送请求后保持连接活动的时间。 |
-| name | string | 可选 | "http logger" | | 标识 logger
的唯一标识符。 |
-| include_req_body | boolean | 可选 | false | [false, true] | 是否包括请求
body。false： 表示不包含请求的 body ； true： 表示包含请求的 body 。 |
-| include_resp_body| boolean | 可选 | false | [false, true] |
是否包括响应体。包含响应体，当为`true`。 |
-| include_resp_body_expr | array | 可选 | | | 是否采集响体，基于
[lua-resty-expr](https://github.com/api7/lua-resty-expr)。 该选项需要开启
`include_resp_body`|
-| concat_method | string | 可选 | "json" | ["json", "new_line"] |
枚举类型： `json`、`new_line`。**json**: 对所有待发日志使用 `json.encode` 编码。**new_line**:
对每一条待发日志单独使用 `json.encode` 编码并使用 "\n" 连接起来。 |
-| ssl_verify | boolean | optional | false | [false, true] |
是否验证证书。 |
+| log_format | object | 可选 | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | 以 JSON
格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 `$` 开头。则表明获取 [APISIX
变量](../../../en/latest/apisix-variable.md) 或 [NGINX
内置变量](http://nginx.org/en/docs/varindex.html)。 |
Review Comment:
```suggestion
| log_format | object | 否 | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | 以 JSON
格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 `$` 开头。则表明获取 [APISIX
变量](../../../en/latest/apisix-variable.md) 或 [NGINX
内置变量](http://nginx.org/en/docs/varindex.html)。 |
```
##########
docs/zh/latest/plugins/http-logger.md:
##########
@@ -65,49 +109,23 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H
'X-API-KEY: edd1c9f034335f13
}'
```
-## 测试插件
-
-> 成功：
-
-```shell
-$ curl -i http://127.0.0.1:9080/hello
-HTTP/1.1 200 OK
-...
-hello, world
-```
-
-## 插件元数据设置
-
-| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述
|
-| ---------------- | ------- | ------ | ------------- | ------- |
------------------------------------------------ |
-| log_format | object | 可选 | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | 以 JSON
格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 `$` 开头，则表明是要获取 [APISIX
变量](../../../en/latest/apisix-variable.md) 或 [Nginx
内置变量](http://nginx.org/en/docs/varindex.html)。特别的，**该设置是全局生效的**，意味着指定
log_format 后，将对所有绑定 http-logger 的 Route 或 Service 生效。 |
-
-### 设置日志格式示例
+[mockbin](http://mockbin.org/bin/create) 服务器用于模拟 HTTP 服务器，以方便查看 APISIX 生成的日志。
Review Comment:
```suggestion
[mockbin](http://mockbin.org/bin/create) 服务器用于模拟 HTTP 服务器，以方便查看 APISIX 生成的日志。
```
##########
docs/zh/latest/plugins/http-logger.md:
##########
@@ -23,32 +31,68 @@ title: http-logger
## 描述
-`http-logger` 是一个插件，可将 Log 数据请求推送到 HTTP / HTTPS 服务器。
-
-这将提供将 Log 数据请求作为 JSON 对象发送到监视工具和其他 HTTP 服务器的功能。
+`http-logger`插件可以将 APISIX 的日志数据推送到 HTTP 或 HTTPS 服务器。该插件提供了将日志数据请求作为 JSON
对象发送到监控工具或者其他 HTTP 服务器的功能。
Review Comment:
```suggestion
`http-logger` 插件可以将 APISIX 的日志数据推送到 HTTP 或 HTTPS 服务器。该插件提供了将日志数据请求作为 JSON
对象发送到监控工具或者其他 HTTP 服务器的功能。
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
