Upstream Sticky#

Vincula sessões de clientes a servidores em grupos do módulo Stream Upstream, de modo que as conexões de uma sessão sejam encaminhadas ao mesmo servidor. As diretivas do módulo são definidas no bloco upstream.

Ao compilar a partir do código-fonte, o módulo é compilado por padrão junto com o módulo Stream (habilitado com --with-stream); ele pode ser desabilitado com a opção de compilação --without-stream_upstream_sticky_module.

Em pacotes e imagens de nossos repositórios, o módulo está incluído na compilação.

Exemplo de configuração#

upstream backend {
    zone backend 1m;
    server backend1.example.com:1935;
    server backend2.example.com:1935;

    sticky learn zone=clients:1m create=$remote_addr lookup=$remote_addr;
}

O Angie vincula cada endereço de cliente ao servidor de sua primeira sessão e encaminha as conexões seguintes desse endereço ao mesmo servidor.

Diretivas#

sticky#

Sintaxe

sticky route value...;

sticky learn zone=zone create=$create_var1... lookup=$lookup_var1... [connect] [norefresh] [timeout=time];

sticky learn [zone=zone] lookup=$lookup_var1... remote_action=uri remote_result=$remote_var [remote_uri=uri] [norefresh] [timeout=time]; (PRO)

Padrão

—

Contexto

upstream

Configura sessões persistentes entre clientes e servidores upstream, dependendo do modo especificado no primeiro parâmetro. Para gradualmente tirar servidores com sticky de rotação, você pode usar a opção drain no bloco server.

Aviso

A diretiva sticky deve aparecer após todas as diretivas de método de balanceamento de carga, caso contrário não funcionará.

Este modo usa identificadores de rota predefinidos que podem ser incorporados em propriedades de conexão acessíveis ao Angie. É menos flexível, pois depende de valores predefinidos, mas é mais adequado se tais identificadores já estiverem em uso.

Aqui, ao estabelecer uma conexão, o servidor upstream pode atribuir uma rota ao cliente e retornar seu identificador de uma forma conhecida por ambas as partes. O identificador de rota deve usar o valor do parâmetro sid da diretiva server. Note que o parâmetro é adicionalmente hasheado se a diretiva sticky_secret for especificada.

Conexões subsequentes de clientes que desejam usar esta rota devem conter o identificador emitido pelo servidor, de tal forma que ele termine em variáveis do Angie.

Os parâmetros da diretiva especificam strings que podem incluir variáveis para roteamento. Para selecionar o servidor para onde a conexão de entrada é direcionada, o primeiro valor não vazio é usado; ele é então comparado com o parâmetro sid da diretiva server. Se a seleção do servidor falhar ou o servidor selecionado não puder aceitar a conexão, outro servidor será selecionado de acordo com o método de balanceamento de carga configurado.

Aqui o Angie procura o identificador de rota na variável $route, que recebe seu valor baseado em $ssl_preread_server_name (note que ssl_preread deve estar habilitado):

stream {

    map $ssl_preread_server_name $route {

        a.example.com            a;
        b.example.com            b;
        default                  "";
    }

    upstream backend {

        zone backend 1m;

        server 127.0.0.1:8081 sid=a;
        server 127.0.0.1:8082 sid=b;

        sticky route $route;
    }

    server {

        listen 127.0.0.1:8080;

        ssl_preread on;

        proxy_pass backend;
    }
}

A diretiva sticky leva em consideração o estado dos servidores em upstream:

  • Servidores marcados como down ou temporariamente indisponíveis devido a falhas são excluídos da seleção.

  • Servidores que atingiram o número máximo de conexões (ao usar max_conns) são temporariamente ignorados.

  • Servidores com a opção drain podem ser selecionados para criar novas sessões no modo sticky quando os identificadores correspondem.

  • Se um servidor anteriormente indisponível se recuperar, sticky automaticamente retoma seu uso.

O comportamento de sticky pode ser configurado adicionalmente com as diretivas sticky_secret e sticky_strict. Se sticky falhar ao selecionar um servidor ou ele estiver indisponível, a requisição será tratada de acordo com o método de balanceamento de carga selecionado, a menos que a diretiva sticky_strict esteja habilitada. No modo sticky_strict on;, a requisição é rejeitada com um erro.

Zonas de memória compartilhada especificadas no parâmetro zone da diretiva sticky não podem ser compartilhadas entre diferentes grupos upstream; cada grupo deve usar sua própria zona.

sticky_secret#

Sintaxe

sticky_secret string;

Padrão

—

Contexto

upstream

Adiciona string como salt à função hash MD5 para a diretiva sticky no modo route. String pode conter variáveis, por exemplo $remote_addr:

upstream backend {
    zone backend 1m;
    server 127.0.0.1:8081 sid=a;
    server 127.0.0.1:8082 sid=b;

    sticky route $route;
    sticky_secret my_secret.$remote_addr;
}

O salt é adicionado após o valor com hash; para verificar independentemente o mecanismo de hashing:

$ echo -n "<VALUE><SALT>" | md5sum

sticky_strict#

Sintaxe

sticky_strict on | off;

Padrão

sticky_strict off;

Contexto

upstream

Quando habilitado, o Angie retorna um erro de conexão para o cliente se o identificador do servidor vinculado à sessão não corresponder a nenhum servidor do grupo ou se esse servidor estiver indisponível, em vez de recorrer ao balanceamento de carga (o comportamento padrão).

Variáveis integradas#

A variável $upstream_sticky_status do módulo Stream Upstream mostra se uma conexão trouxe dados de sessão e se chegou ao servidor vinculado. O próprio módulo stream_upstream_sticky suporta as seguintes variáveis integradas:

$sticky_sessid (PRO)#

Usado com remote_action em sticky; armazena o identificador de sessão inicial obtido de lookup.

$sticky_sid (PRO)#

Usado com remote_action em sticky; armazena o identificador do servidor pré-selecionado pelo método de balanceamento de carga: o valor sid= do servidor ou seu padrão gerado (veja server).