Zum Inhalt

balancer: Eine generische konsistente Hash-Implementierung für nginx-module-lua

Installation

Wenn Sie das RPM-Repository-Abonnement noch nicht eingerichtet haben, melden Sie sich an. Dann können Sie mit den folgenden Schritten fortfahren.

CentOS/RHEL 7 oder 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

Um diese Lua-Bibliothek mit NGINX zu verwenden, stellen Sie sicher, dass nginx-module-lua installiert ist.

Dieses Dokument beschreibt lua-resty-balancer v0.5, das am 24. Mai 2023 veröffentlicht wurde.


Diese Lua-Bibliothek kann mit balancer_by_lua* verwendet werden.

Synopsis

    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: wir können die folgenden Schritte unternehmen, um die Konsistenz mit nginx chash zu wahren
        local str_null = string.char(0)

        local servers, nodes = {}, {}
        for serv, weight in pairs(server_list) do
            -- XX: wir können serv einfach als id verwenden, wenn wir keine Konsistenz mit nginx chash wahren müssen
            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

            -- wir können hier nach jedem Schlüssel balancieren
            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

            -- Beachten Sie, dass Round Robin den ersten Server zufällig auswählt
            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

            -- Beachten Sie, dass SWRR den ersten Server zufällig auswählt
            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;
        }
    }

Methoden

Sowohl resty.chash, resty.roundrobin als auch resty.swrr haben die gleichen APIs.

new

syntax: obj, err = class.new(nodes)

Instanziiert ein Objekt dieser Klasse. Der class-Wert wird durch den Aufruf require "resty.chash" zurückgegeben.

Die id sollte table.concat({host, string.char(0), port}) sein, wie es nginx chash tut, wenn wir die Konsistenz mit nginx chash wahren müssen.

Die id kann jeder Stringwert sein, wenn wir keine Konsistenz mit nginx chash wahren müssen. Das weight sollte eine nicht negative ganze Zahl sein.

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

syntax: obj:reinit(nodes)

Reinitialisiert das chash-Objekt mit den neuen nodes.

set

syntax: obj:set(id, weight)

Setzt das weight der id.

delete

syntax: obj:delete(id)

Löscht die id.

incr

syntax: obj:incr(id, weight?)

Erhöht das Gewicht für die id um den Schrittwert weight (Standardwert ist 1).

decr

syntax: obj:decr(id, weight?)

Verringert das Gewicht für die id um den Schrittwert weight (Standardwert ist 1).

find

syntax: id, index = obj:find(key)

Findet eine id anhand des key, der gleiche key gibt immer die gleiche id im gleichen obj zurück.

Der zweite Rückgabewert index ist der Index im chash-Kreis des Hashwerts des key.

next

syntax: id, new_index = obj:next(old_index)

Wenn wir die Möglichkeit haben, es erneut zu versuchen, wenn die erste id (Server) nicht gut funktioniert, können wir obj:next verwenden, um die nächste id zu erhalten.

Die neue id kann die gleiche wie die alte sein.

Leistung

Es gibt ein Benchmark-Skript t/bench.lua.

Ich habe das Ergebnis erhalten, als ich make bench ausgeführt habe:

chash new servers
10000 mal
verstrichene Zeit: 0.61600017547607

chash new servers2
1000 mal
verstrichene Zeit: 0.77300000190735

chash new servers3
10000 mal
verstrichene Zeit: 0.66899991035461

new in func
10000 mal
verstrichene Zeit: 0.62000012397766

new dynamic
10000 mal
verstrichene Zeit: 0.75499987602234

incr server3
10000 mal
verstrichene Zeit: 0.19000029563904

incr server1
10000 mal
verstrichene Zeit: 0.33699989318848

decr server1
10000 mal
verstrichene Zeit: 0.27300024032593

delete server3
10000 mal
verstrichene Zeit: 0.037999868392944

delete server1
10000 mal
verstrichene Zeit: 0.065000057220459

set server1 9
10000 mal
verstrichene Zeit: 0.26600003242493

set server1 8
10000 mal
verstrichene Zeit: 0.32000017166138

set server1 1
10000 mal
verstrichene Zeit: 0.56699991226196

Basis für find
1000000 mal
verstrichene Zeit: 0.01800012588501

find
1000000 mal
verstrichene Zeit: 0.9469997882843

Siehe auch

GitHub

Sie finden zusätzliche Konfigurationstipps und Dokumentationen für dieses Modul im GitHub-Repository für nginx-module-balancer.