跳转至

balancer: NGINX模块Lua的通用一致性哈希实现

安装

如果您尚未设置RPM仓库订阅，请注册。然后您可以继续以下步骤。

CentOS/RHEL 7 或 Amazon Linux 2

yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install lua-resty-balancer

CentOS/RHEL 8+、Fedora Linux、Amazon Linux 2023

dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install lua5.1-resty-balancer

要在NGINX中使用此Lua库，请确保已安装nginx-module-lua。

本文档描述了lua-resty-balancer v0.5，于2023年5月24日发布。

此Lua库可以与balancer_by_lua*一起使用。

概述

    init_by_lua_block {
        local resty_chash = require "resty.chash"
        local resty_roundrobin = require "resty.roundrobin"
        local resty_swrr = require "resty.swrr"

        local server_list = {
            ["127.0.0.1:1985"] = 2,
            ["127.0.0.1:1986"] = 2,
            ["127.0.0.1:1987"] = 1,
        }

        -- XX: 我们可以执行以下步骤以保持与nginx chash的一致性
        local str_null = string.char(0)

        local servers, nodes = {}, {}
        for serv, weight in pairs(server_list) do
            -- XX: 当我们不需要与nginx chash保持一致性时，可以直接使用serv作为id
            local id = string.gsub(serv, ":", str_null)

            servers[id] = serv
            nodes[id] = weight
        end

        local chash_up = resty_chash:new(nodes)

        package.loaded.my_chash_up = chash_up
        package.loaded.my_servers = servers

        local rr_up = resty_roundrobin:new(server_list)
        package.loaded.my_rr_up = rr_up

        local swrr_up = resty_swrr:new(server_list)
        package.loaded.my_swrr_up = swrr_up
    }

    upstream backend_chash {
        server 0.0.0.1;
        balancer_by_lua_block {
            local b = require "ngx.balancer"

            local chash_up = package.loaded.my_chash_up
            local servers = package.loaded.my_servers

            -- 我们可以在这里根据任何键进行负载均衡
            local id = chash_up:find(ngx.var.arg_key)
            local server = servers[id]

            assert(b.set_current_peer(server))
        }
    }

    upstream backend_rr {
        server 0.0.0.1;
        balancer_by_lua_block {
            local b = require "ngx.balancer"

            local rr_up = package.loaded.my_rr_up

            -- 请注意，轮询随机选择第一个服务器
            local server = rr_up:find()

            assert(b.set_current_peer(server))
        }
    }

    upstream backend_swrr {
        server 0.0.0.1;
        balancer_by_lua_block {
            local b = require "ngx.balancer"

            local swrr_up = package.loaded.my_swrr_up

            -- 请注意，SWRR随机选择第一个服务器
            local server = swrr_up:find()

            assert(b.set_current_peer(server))
        }
    }

    server {
        location /chash {
            proxy_pass http://backend_chash;
        }

        location /roundrobin {
            proxy_pass http://backend_rr;
        }

        location /swrr {
            proxy_pass http://backend_swrr;
        }
    }

方法

resty.chash、resty.roundrobin和resty.swrr具有相同的API。

new

语法: obj, err = class.new(nodes)

实例化此类的对象。class值由调用require "resty.chash"返回。

当我们需要与nginx chash保持一致性时，id应为table.concat({host, string.char(0), port})，与nginx chash的做法相同。

当我们不需要与nginx chash保持一致性时，id可以是任何字符串值。weight应为非负整数。

local nodes = {
    -- id => weight
    server1 = 10,
    server2 = 2,
}

local resty_chash = require "resty.chash"

local chash = resty_chash:new(nodes)

local id = chash:find("foo")

ngx.say(id)

reinit

语法: obj:reinit(nodes)

使用新的nodes重新初始化chash对象。

set

语法: obj:set(id, weight)

设置id的weight。

delete

语法: obj:delete(id)

删除id。

incr

语法: obj:incr(id, weight?)

将id的权重增加weight（默认为1）。

decr

语法: obj:decr(id, weight?)

将id的权重减少weight（默认为1）。

find

语法: id, index = obj:find(key)

通过key查找id，相同的key在同一个obj中总是返回相同的id。

第二个返回值index是key的哈希值在chash圆中的索引。

next

语法: id, new_index = obj:next(old_index)

如果在第一个id（服务器）运行不良时我们有机会重试， 那么我们可以使用obj:next来获取下一个id。

新的id可能与旧的相同。

性能

有一个基准测试脚本t/bench.lua。

我在运行make bench时得到了以下结果：

chash new servers
10000 times
elasped: 0.61600017547607

chash new servers2
1000 times
elasped: 0.77300000190735

chash new servers3
10000 times
elasped: 0.66899991035461

new in func
10000 times
elasped: 0.62000012397766

new dynamic
10000 times
elasped: 0.75499987602234

incr server3
10000 times
elasped: 0.19000029563904

incr server1
10000 times
elasped: 0.33699989318848

decr server1
10000 times
elasped: 0.27300024032593

delete server3
10000 times
elasped: 0.037999868392944

delete server1
10000 times
elasped: 0.065000057220459

set server1 9
10000 times
elasped: 0.26600003242493

set server1 8
10000 times
elasped: 0.32000017166138

set server1 1
10000 times
elasped: 0.56699991226196

base for find
1000000 times
elasped: 0.01800012588501

find
1000000 times
elasped: 0.9469997882843

另见

GitHub

您可以在nginx-module-balancer的GitHub仓库中找到此模块的其他配置提示和文档。