proxy-mirror
proxy-mirror 插件复制 APISIX 的入口流量并将其转发到指定的上游,而不会中断常规服务。你可以配置插件镜像所有流量或仅镜像一部分流量。该机制有利于多种用例,包括故障排除、安全检查、分析等。
请注意,APISIX 会忽略接收镜像流量的上游主机的任何响应。
示例
以下示例演示了如何为不同场景配置 proxy-mirror。
镜像部分流量
以下示例演示了如何配置 proxy-mirror 以将 50% 的流量镜像到路由并将其转发到另一个上游服务。
启动一个示例 NGINX 服务器以接收镜像流量:
- Docker
- Kubernetes
docker run -p 8081:80 --name nginx nginx
你应该在终端会话中看到 NGINX 访问日志 和错误日志。
为 NGINX 部署创建 Kubernetes 清单文件:
apiVersion: apps/v1
kind: Deployment
metadata:
namespace: aic
name: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
namespace: aic
name: nginx
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
type: ClusterIP
将该清单应用到集群:
kubectl apply -f nginx-deployment.yaml
打开一个新的终端会话并创建一个带有 proxy-mirror 的路由:
- Admin API
- ADC
- Ingress Controller
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"
}
}'
services:
- name: proxy-mirror-service
routes:
- name: traffic-mirror-route
uris:
- /get
plugins:
proxy-mirror:
host: "http://127.0.0.1:8081"
sample_ratio: 0.5
upstream:
type: roundrobin
nodes:
- host: httpbin.org
port: 80
weight: 1
将配置同步到网关:
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
apiVersion: v1
kind: Service
metadata:
namespace: aic
name: httpbin-external-domain
spec:
type: ExternalName
externalName: httpbin.org
---
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
namespace: aic
name: proxy-mirror-plugin-config
spec:
plugins:
- name: proxy-mirror
config:
host: "http://nginx.aic.svc"
sample_ratio: 0.5
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: aic
name: traffic-mirror-route
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /get
filters:
- type: ExtensionRef
extensionRef:
group: apisix.apache.org
kind: PluginConfig
name: proxy-mirror-plugin-config
backendRefs:
- name: httpbin-external-domain
port: 80
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
namespace: aic
name: httpbin-external-domain
spec:
ingressClassName: apisix
externalNodes:
- type: Domain
name: httpbin.org
---
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: aic
name: traffic-mirror-route
spec:
ingressClassName: apisix
http:
- name: traffic-mirror-route
match:
paths:
- /get
upstreams:
- name: httpbin-external-domain
plugins:
- name: proxy-mirror
enable: true
config:
host: "http://nginx.aic.svc"
sample_ratio: 0.5
将配置应用到集群:
kubectl apply -f proxy-mirror-ic.yaml
❶ 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 秒。若要更改这些默认值,请配置网关静态设置:
- 主机或 Docker
- Kubernetes (Helm)
在网关配置文件中添加或更新以下配置:
plugin_attr:
proxy-mirror:
timeout:
connect: 2000ms
read: 2000ms
send: 2000ms
重新加载网关以使更改生效。
对于 Helm 部署,请更新用于渲染 plugin_attr.proxy-mirror 的 Chart values,并保持 values 文件的其余部分不变。
对于 APISIX Helm Chart,请设置以下值:
apisix:
pluginAttrs:
proxy-mirror:
timeout:
connect: 2000ms
read: 2000ms
send: 2000ms
对于 API7 Gateway Helm Chart,请设置以下值:
pluginAttrs:
proxy-mirror:
timeout:
connect: 2000ms
read: 2000ms
send: 2000ms
然后使用当前网关版本对应的 Chart 应用该 values 文件:
helm upgrade <release-name> <chart-name> -n <namespace> -f values.yaml