跳到主要内容

proxy-mirror

proxy-mirror 插件复制 APISIX 的入口流量并将其转发到指定的上游,而不会中断常规服务。你可以配置插件镜像所有流量或仅镜像一部分流量。该机制有利于多种用例,包括故障排除、安全检查、分析等。

请注意,APISIX 会忽略接收镜像流量的上游主机的任何响应。

示例

以下示例演示了如何为不同场景配置 proxy-mirror

镜像部分流量

以下示例演示了如何配置 proxy-mirror 以将 50% 的流量镜像到路由并将其转发到另一个上游服务。

启动一个示例 NGINX 服务器以接收镜像流量:

docker run -p 8081:80 --name nginx nginx

你应该在终端会话中看到 NGINX 访问日志和错误日志。

打开一个新的终端会话并创建一个带有 proxy-mirror 的路由:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-d '{
"id": "traffic-mirror-route",
"uri": "/get",
"plugins": {
"proxy-mirror": {
"host": "http://127.0.0.1:8081",
"sample_ratio": 0.5
}
},
"upstream": {
"nodes": {
"httpbin.org": 1
},
"type": "roundrobin"
}
}'

host: 配置要转发镜像流量的方案和主机地址。

sample_ratio: 将采样率配置为 0.5 以镜像 50% 的流量。

向路由生成几个请求:

curl -i "http://127.0.0.1:9080/get"

你应该会收到所有请求的 HTTP/1.1 200 OK 响应。

回到 NGINX 终端会话,你应该会看到许多访问日志条目,大约是生成的请求数的一半:

172.17.0.1 - - [29/Jan/2024:23:11:01 +0000] "GET /get HTTP/1.1" 404 153 "-" "curl/7.64.1" "-"

这表明 APISIX 已将请求镜像到 NGINX 服务器。在这里,HTTP 响应状态为 404,因为示例 NGINX 服务器未实现该路由。

配置镜像超时

以下示例演示了如何更新插件的默认连接、读取和发送超时。当将流量镜像到非常慢的后端服务时,这可能很有用。

由于请求镜像是作为子请求实现的,子请求中的过多延迟可能导致原始请求阻塞。默认情况下,连接、读取和发送超时设置为 60 秒。要更新这些值,你可以按如下方式在配置文件plugin_attr 部分中进行配置:

conf/config.yaml
plugin_attr:
proxy-mirror:
timeout:
connect: 2000ms
read: 2000ms
send: 2000ms

重新加载 APISIX 以使更改生效。