文档首页/ API网关 APIG/ 用户指南/ API策略/ 流量镜像策略说明
更新时间:2024-10-17 GMT+08:00

流量镜像策略说明

API网关提供了镜像客户端请求的能力,将发送到源后端的流量复制一份到镜像服务中,在不影响业务后端的情况下,便于对请求内容进行具体的分析和统计。

使用限制

  • 使用前,请先了解前提条件
  • 镜像请求返回的响应会被忽略。
  • 镜像请求的请求体大小受实例参数“request_body_size”控制,默认请求体大小为12MB,可通过“request_body_size”参数调整请求体大小,请求体大小调整越大性能损耗越大,请谨慎操作。
  • API的后端服务类型为Mock时,不支持绑定流量镜像策略。

配置参数说明

表1 配置参数说明

参数

说明

镜像协议

镜像请求协议。指定的镜像服务协议须与用户的镜像业务协议保持一致。

镜像地址

镜像服务的地址。由IP/域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx:7443)。如果不写端口号,那么HTTPS默认端口号为443,HTTP默认端口号为80。

镜像请求路径

当“镜像协议”为HTTP/HTTPS时设置。

镜像请求的路径,支持* % - _ .等特殊字符,总长度不超过512,且满足URI规范。如果不指定镜像请求路径,那么默认使用绑定的API的请求路径。

拼接模式

当指定镜像请求的路径后,可以设置请求路径的拼接模式。

replace模式:表示使用指定的“镜像请求路径”作为镜像请求的路径。

prefix模式:表示使用指定的“镜像请求路径”+API的请求路径作为镜像请求的路径。

采样率

镜像请求的采样率,取值范围:0.00001~1。当设置为1时为全采样,默认为1。

例如,API请求流量为1000,采样率为0.1,那么采样的线上请求流量为100。

超时时间(ms)

镜像请求的超时时间,单位ms。默认超时时间为5000ms。

客户端请求体

镜像客户端的请求体,默认开启镜像客户端请求体。

脚本配置示例

{
  "protocol": "HTTPS",
  "host": "X.X.X.X",
  "sample_ratio": 1,
  "timeout": 5000,
  "mirror_request_body_enabled": true,
  "path": "/ab",
  "path_concat_mode": "replace"
}