基于 Nginx Lua 的灰度发布：针对特定用户或 IP 的流量控制方案

2025/7/11 06:21:21 129 0 0 0

灰度发布，又称金丝雀发布，是一种平滑过渡的发布方式，允许将新版本的应用逐步推向用户，同时监控新版本在实际环境中的表现。本文将介绍如何利用 Nginx 的 Lua 模块实现针对特定用户或 IP 地址范围的灰度发布功能。

1. 准备工作

安装 Nginx： 确保已安装 Nginx，并配置好基本的 Web 服务。
安装 Lua 模块： 确保 Nginx 已经安装了 ngx_http_lua_module 模块。可以通过 nginx -V 命令查看是否包含 --with-http_lua_module 选项。如果没有，需要重新编译 Nginx 并添加该模块。
了解 Lua 语法： 熟悉 Lua 的基本语法，能够编写简单的 Lua 脚本。

2. 实现思路

获取用户标识： 通过 Nginx 获取用户的标识信息，例如 Cookie 中的用户 ID，或者客户端的 IP 地址。
判断是否灰度： 使用 Lua 脚本判断当前用户是否属于灰度发布的范围。可以通过配置用户 ID 列表或 IP 地址范围来实现。
流量转发： 如果用户属于灰度发布的范围，则将请求转发到新的应用版本；否则，转发到旧的应用版本。

3. 配置步骤

3.1 修改 Nginx 配置文件

在 Nginx 的配置文件（例如 nginx.conf）中，找到需要进行灰度发布的 location 块，并添加 Lua 脚本的配置。以下是一个示例：

location / {
    access_by_lua_file /path/to/gray_release.lua;
    proxy_pass http://backend;
}

access_by_lua_file 指令指定 Lua 脚本的路径，该脚本将在每个请求到达时执行。
proxy_pass 指令指定后端服务器的地址，这里假设后端服务器组名为 backend。稍后我们将配置不同的后端服务器地址。

3.2 编写 Lua 脚本

创建 Lua 脚本文件（例如 /path/to/gray_release.lua），并编写以下代码：

-- 定义灰度发布的用户 ID 列表
local gray_users = {"user1", "user2", "user3"}

-- 定义新的应用版本服务器地址
local new_version_backend = "http://new_backend";

-- 获取用户 ID (假设从 Cookie 中获取)
local cookie = ngx.var.http_cookie
local user_id = string.match(cookie, "userid=(%w+)")

-- 获取客户端 IP 地址
local client_ip = ngx.var.remote_addr

-- 定义灰度发布的 IP 地址范围 (例如：192.168.1.100 - 192.168.1.200)
local ip_range_start = "192.168.1.100"
local ip_range_end = "192.168.1.200"

local function ip_to_number(ip)
  local num = 0
  for i, v in ipairs({string.match(ip, '(.*)%.(.*)%.(.*)%.(.*)')})
  do
    num = num + v * (256 ^ (4 - i))
  end
  return num
end

local ip_num = ip_to_number(client_ip)
local ip_start_num = ip_to_number(ip_range_start)
local ip_end_num = ip_to_number(ip_range_end)

-- 检查用户 ID 是否在灰度发布列表中
local is_gray_user = false
if user_id then
    for i, user in ipairs(gray_users) do
        if user == user_id then
            is_gray_user = true
            break
        end
    end
end

-- 检查 IP 地址是否在灰度发布范围内
local is_gray_ip = false
if ip_num >= ip_start_num and ip_num <= ip_end_num then
    is_gray_ip = true
end

-- 如果是灰度用户或灰度 IP，则将请求转发到新的应用版本
if is_gray_user or is_gray_ip then
    ngx.log(ngx.INFO, "Gray user/IP: ", client_ip, " - Forwarding to new version")
    ngx.var.upstream = new_version_backend
else
    ngx.log(ngx.INFO, "Normal user/IP: ", client_ip, " - Forwarding to old version")
    ngx.var.upstream = "http://backend";
end

return

代码解释：

gray_users：定义一个数组，包含需要进行灰度发布的用户 ID。
new_version_backend：定义新的应用版本服务器地址。
ngx.var.http_cookie：获取客户端的 Cookie 信息。
string.match(cookie, "userid=(%w+)")：从 Cookie 中提取 userid 的值。
ngx.var.remote_addr：获取客户端的 IP 地址。
ngx.var.upstream：设置上游服务器的地址。这里根据是否为灰度用户，动态地设置上游服务器地址。
ngx.log(ngx.INFO, ...)：记录日志信息，方便调试。

3.3 配置 Nginx Upstream

在 Nginx 配置文件中，定义 backend 和 new_version_backend 这两个 upstream。例如：

ups tream backend {
    server 192.168.1.10:8080;
    server 192.168.1.11:8080;
}

ups tream new_version_backend {
    server 192.168.1.12:8080;
}

backend 指向旧的应用版本的服务器。
new_version_backend 指向新的应用版本的服务器。

3.4 重启 Nginx

完成配置后，重启 Nginx 使配置生效：

sudo nginx -s reload

4. 测试验证

使用灰度用户 ID 访问： 在浏览器中设置包含灰度用户 ID 的 Cookie，然后访问应用。应该被转发到新的应用版本。
使用非灰度用户 ID 访问： 在浏览器中设置不包含灰度用户 ID 的 Cookie，然后访问应用。应该被转发到旧的应用版本。
使用灰度 IP 地址访问： 使用位于灰度 IP 地址范围内的客户端访问应用。应该被转发到新的应用版本。
使用非灰度 IP 地址访问： 使用位于灰度 IP 地址范围外的客户端访问应用。应该被转发到旧的应用版本。

通过查看 Nginx 的日志，可以确认流量是否按照预期进行转发。

5. 注意事项

用户 ID 的获取方式： 本示例假设用户 ID 从 Cookie 中获取。实际情况可能需要根据应用的具体实现来调整。例如，可以从 Header 中获取，或者通过 OAuth 认证等方式。
IP 地址的获取： 如果 Nginx 部署在反向代理之后，需要确保获取到的是真实的客户端 IP 地址，而不是代理服务器的 IP 地址。可以通过配置 X-Forwarded-For Header 来实现。
灰度策略的灵活性： 可以根据实际需求，调整灰度发布的策略。例如，可以按照一定的百分比进行灰度发布，或者根据用户的地理位置进行灰度发布。
监控和告警： 在进行灰度发布时，需要密切监控新版本的应用在实际环境中的表现。一旦发现问题，需要及时回滚到旧版本。
Lua 脚本的性能： 复杂的 Lua 脚本可能会影响 Nginx 的性能。需要对 Lua 脚本进行优化，避免出现性能瓶颈。可以使用 LuaJIT 来提高 Lua 脚本的执行效率。
代码安全性： 确保 Lua 脚本的安全性，防止恶意代码注入。

6. 总结

本文介绍了如何使用 Nginx 的 Lua 模块实现针对特定用户或 IP 地址范围的灰度发布功能。通过 Lua 脚本，可以灵活地控制流量的转发，实现平滑过渡的发布方式。在实际应用中，需要根据具体的需求，调整灰度发布的策略，并密切监控新版本的应用在实际环境中的表现。

Nginx 玩家 Nginx Lua 灰度发布