跳到主要内容
版本:3.8.x

配置灰度流量切分

灰度流量切分通过逐步将一小部分流量路由到新上游,并将大部分流量保留在稳定的默认上游,实现对新上游的安全测试。渐进式方式将潜在问题限制在少量用户范围内,从而降低风险,让你能够识别和解决问题,而不影响更广泛的用户群体。

备注

灰度流量切分与灰度发布不同,API 或服务版本不会改变。灰度发布指同一 API 或服务的两个版本同时运行并提供服务。

前提条件​

  1. 安装 API7 企业版。
  2. 创建一条路径为 /headers 的路由。

按权重切分流量​

本示例将 10% 的流量路由到新上游,其余 90% 继续转发到默认上游。

测试新上游后,可以考虑使用新值更新默认上游配置,并删除插件,以结束灰度过程。

  1. 从侧边栏选择网关组的已发布服务,然后点击要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在已发布服务下,从侧边栏选择上游。
  3. 在连接配置模块中点击编辑,选择 使用节点主机,然后点击保存。

    注意:mock.api7.ai 强制使用 HTTPS,因此上游需要为 HTTPS 端点配置端口 443。必须将 pass_host 参数更改为 nodes,以确保与上游成功握手。请根据你的使用场景相应调整。

  4. 点击新增上游。
  5. 在对话框中,执行以下操作:
    • 在上游名称字段中输入 new upstream。
    • 点击新增节点,调整节点主机以指向新后端。例如,使用 mock.api7.ai 作为主机,443 作为端口。
    • 点击新增。
  6. 点击上游页头操作按钮下的查看 ID,复制该 ID 以供后续使用。
  7. 在已发布服务下,从侧边栏选择插件。
  8. 点击新增插件。
  9. 搜索 traffic-split 插件,然后点击新增。
  10. 在对话框中,执行以下操作:
  • 将以下配置添加到 JSON 编辑器:

    {
    "rules": [
    {
    "weighted_upstreams": [
    {
    "upstream_id": "new_upstream_id", // 使用上游 ID,而不是上游名称
    "weight": 1
    },
    {
    "weight": 9
    }
    ]
    }
    ]
    }
  • 点击新增。

验证

发送 10 个请求,验证灰度规则:

for i in {1..10}; do "curl 127.0.0.1:9080/headers"; done

9 个请求将发送到默认上游地址 httpbin.org,你将收到以下响应:

{
"headers": {
"Accept": "*/*",
"Host": "httpbin.org",
"User-Agent": "curl/7.74.0",
"X-Amzn-Trace-Id": "Root=1-6650ab7e-32c90eba787abbeb4e3dbb0c",
"X-Forwarded-Host": "127.0.0.1"
}
}

一个请求将发送到新上游地址 mock.api7.ai:

{
"headers": {
"accept": "*/*",
"accept-encoding": "gzip, br",
"cf-connecting-ip": "159.89.160.194",
"cf-ipcountry": "IN",
"cf-ray": "888e28733f9604aa",
"cf-visitor": "{\"scheme\":\"https\"}",
"connection": "Keep-Alive",
"content-type": "application/json",
"host": "mock.api7.ai",
"user-agent": "curl/7.74.0",
"x-application-owner": "API7.ai",
"x-forwarded-for": "127.0.0.1",
"x-forwarded-host": "127.0.0.1",
"x-forwarded-port": "9080",
"x-forwarded-proto": "https",
"x-real-ip": "159.89.160.194",
"X-Application-Owner": "API7.ai",
"Content-Type": "application/json"
}
}

以下是此场景的互动演示。点击并按照演示步骤操作,可以进一步了解如何在 API7 企业版中使用该功能。

按条件切分流量:请求头​

本示例将带有 version = test 请求头的请求路由到新上游,其余流量继续发送到默认上游。灰度规则适用于服务中的所有路由,不能应用于单个路由。

  1. 从侧边栏选择网关组的已发布服务,然后点击要修改的服务,例如版本为 1.0.0 的 httpbin。
  2. 在服务下,从侧边栏选择上游。
  3. 点击新增上游。
  4. 在对话框中,执行以下操作:
    • 在上游名称字段中输入 new upstream。
    • 点击新增节点,调整节点主机以指向新后端。例如,使用 mock.api7.ai 作为主机,443 作为端口。
    • 点击新增。
  5. 点击上游页头操作按钮下的查看 ID,复制该 ID 以供后续使用。
  6. 在已发布服务下,从侧边栏选择插件。
  7. 点击新增插件。
  8. 搜索 traffic-split 插件,然后点击新增。
  9. 在对话框中,执行以下操作:
  • 将以下配置添加到 JSON 编辑器:

    {
    "rules": [
    {
    "match": [
    {
    "vars": [
    [
    "version",
    "==",
    "test"
    ]
    ]
    }
    ],
    "weighted_upstreams": [
    {
    "upstream_id": "new_upstream_id", // 使用上游 ID,而不是上游名称
    "weight": 1
    },
    {
    "weight": 9
    }
    ]
    }
    ]
    }
  • 点击新增。

验证

发送请求,验证灰度规则:

  • 发送带有 version:test 请求头的请求:

    curl 127.0.0.1:9080/headers -H "version:test"

    你应该会收到以下来自新上游的响应:

    {
    "headers": {
    "accept": "*/*",
    "accept-encoding": "gzip, br",
    "cf-connecting-ip": "159.89.160.194",
    "cf-ipcountry": "IN",
    "cf-ray": "888e28733f9604aa",
    "cf-visitor": "{\"scheme\":\"https\"}",
    "connection": "Keep-Alive",
    "content-type": "application/json",
    "host": "mock.api7.ai",
    "user-agent": "curl/7.74.0",
    "x-application-owner": "API7.ai",
    "x-forwarded-for": "127.0.0.1",
    "x-forwarded-host": "127.0.0.1",
    "x-forwarded-port": "9080",
    "x-forwarded-proto": "https",
    "x-real-ip": "159.89.160.194",
    "X-Application-Owner": "API7.ai",
    "Content-Type": "application/json"
    }
    }
  • 发送带有错误请求头的请求:

    curl 127.0.0.1:9080/headers -H "version:new"

    你应该会收到以下来自默认上游的响应:

    {
    "headers": {
    "Accept": "*/*",
    "Host": "httpbin.org",
    "User-Agent": "curl/7.74.0",
    "X-Amzn-Trace-Id": "Root=1-6650ab7e-32c90eba787abbeb4e3dbb0c",
    "X-Forwarded-Host": "127.0.0.1"
    }
    }
  • 发送不带请求头的请求:

    curl 127.0.0.1:9080/headers
  • 你应该会收到以下来自默认上游的响应:

    {
    "headers": {
    "Accept": "*/*",
    "Host": "httpbin.org",
    "User-Agent": "curl/7.74.0",
    "X-Amzn-Trace-Id": "Root=1-6650ab7e-32c90eba787abbeb4e3dbb0c",
    "X-Forwarded-Host": "127.0.0.1"
    }
    }
  1. 发送更多请求测试新上游,直到其符合你的预期。

相关阅读​