[GitHub] [apisix] hf400159 commented on a diff in pull request #7667: docs(plugin): refactor proxy-mirror.md

[GitBox <gi...@apache.org>]

hf400159 commented on code in PR #7667:
URL: https://github.com/apache/apisix/pull/7667#discussion_r945379027


##########
docs/zh/latest/plugins/proxy-mirror.md:
##########
@@ -23,26 +28,29 @@ title: proxy-mirror
 
 ## 描述
 
-代理镜像插件，该插件提供了镜像客户端请求的能力。
+`proxy-mirror` 插件提供了镜像客户端请求的能力。
 
-注：镜像请求返回的响应会被忽略。
+:::note 注意
+
+镜像请求返回的响应会被忽略。
+
+:::
 
 ## 参数
 
 | 名称 | 类型   | 必选项 | 默认值 | 有效值 | 描述                                                                                                    |
 | ---- | ------ | ------ | ------ | ------ | ------------------------------------------------------------------------------------------------------- |
-| host | string | 必须   |        |        | 指定镜像服务地址，例如：http://127.0.0.1:9797（地址中需要包含 schema ：http 或 https，不能包含 path 部分）|
-| path | string | 可选   |        |        | 指定镜像请求的路径。如不指定，当前路径将被使用。 |
-| sample_ratio | number | 可选    | 1       |  [0.00001, 1]     | 镜像请求采样率 |
-
-## 示例
+| host | string | 是   |        |        | 指定镜像服务的地址，地址中需要包含 `schema`（`http` 或 `https`），但不能包含 `path` 部分。例如 `http://127.0.0.1:9797`。 |
+| path | string | 否   |        |        | 指定镜像请求的路径。如果不指定，则默认会使用当前路径。 |
+| sample_ratio | number | 否    | 1       |  [0.00001, 1]     | 镜像请求的采样率。 |

Review Comment:
   ```suggestion
   | sample_ratio | number | 否    | 1       |  [0.00001, 1]     | 镜像请求的采样率。当设置为 `1` 时为全采样。 |
   ```



##########
docs/zh/latest/plugins/proxy-mirror.md:
##########
@@ -59,29 +67,60 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f1
 }'
 ```
 
-测试：
+### 指定 mirror 子请求的超时时间
+
+我们可以在 `conf/config.yaml` 的 `plugin_attr` 中指定子请求的超时时间。这在连接复用的场景下 mirror 流量到一个非常慢的后端服务时非常有用。
+
+| 名称 | 类型 | 默认值 | 描述 |
+| --- | --- | --- | --- |
+| connect | string | 60s | 镜像请求到上游的连接超时时间。 |
+| read | string | 60s | 镜像请求到上游的读超时时间。 |
+| send | string | 60s | 镜像请求到上游的写超时时间。 |
+
+```yaml
+plugin_attr:
+  proxy-mirror:
+    timeout:
+      connect: 2000ms
+      read: 2000ms
+      send: 2000ms
+```
+
+## 测试插件
+
+:::tip 提示
+
+因为指定的镜像地址是 `127.0.0.1:9797`，所以验证此插件是否正常工作需要在端口为 `9797` 的服务上确认。
+
+我们可以通过 `python` 启动一个简单的 server：

Review Comment:
   ```suggestion
   我们可以通过 `python` 启动一个简单的服务：
   ```



-- 
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