Upstream Sticky#

Vincula sessões de clientes a servidores em grupos do módulo HTTP Upstream, de modo que as requisiçõ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; ele pode ser desabilitado com a opção de compilação --without-http_upstream_sticky_module.

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

Guias relacionados

Exemplo de configuração#

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

    sticky cookie srv_id max-age=3600;
}

Diretivas#

sticky#

Sintaxe

sticky cookie name [attr=value]...;

sticky route value...;

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

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

Padrão

—

Contexto

upstream

Configura afinidade de sessão para vincular sessões de cliente a servidores proxy no modo especificado pelo primeiro parâmetro; para drenar servidores que têm a diretiva sticky configurada, você pode usar a opção drain no bloco server.

Aviso

A diretiva sticky deve ser usada após todas as diretivas que especificam um método particular de balanceamento de carga, caso contrário não funcionará. Se for usada junto com a diretiva bind_conn (PRO), então bind_conn deve vir após sticky.

Este modo usa cookies para gerenciar sessões. É adequado quando cookies já são usados para rastreamento de sessão.

A primeira requisição do cliente, antes de qualquer aderência se aplicar, é enviada para um servidor backend de acordo com o método de balanceamento configurado. O Angie então define um cookie identificando o servidor escolhido.

O nome do cookie (name) é definido pela diretiva sticky, e seu valor corresponde ao sid da diretiva server. Este valor é posteriormente hasheado se sticky_secret estiver definido.

Requisições subsequentes com este cookie são roteadas para o servidor especificado por seu sid. Se o servidor estiver indisponível ou não puder processar a requisição, outro é escolhido através do método de balanceamento configurado.

Você pode atribuir atributos de cookie na diretiva; por padrão, apenas path=/ é definido. Valores de atributos podem conter variáveis. Para remover um atributo, defina-o como um valor vazio: attr=. Por exemplo, sticky cookie path= omite o atributo path.

Este exemplo define um cookie srv_id por 1 hora, usando um domínio de uma variável:

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

    sticky cookie srv_id domain=$my_domain max-age=3600;
}

A diretiva sticky respeita os estados dos servidores upstream:

  • Servidores marcados como down ou falhando são excluídos.

  • Servidores acima do limite max_conns são ignorados.

  • Servidores drain ainda podem ser selecionados para novas sessões no modo sticky quando os identificadores correspondem.

  • Servidores recuperados são reutilizados automaticamente.

Você pode ajustar ainda mais o comportamento usando sticky_secret e sticky_strict. Se a aderência falhar e sticky_strict estiver desligado, o balanceamento de fallback é usado; se ligado, a requisição é rejeitada.

Cada zone usada em sticky deve ser exclusiva de um único upstream. Zonas não podem ser compartilhadas entre múltiplos blocos upstream.

sticky_secret#

Sintaxe

sticky_secret string;

Padrão

—

Contexto

upstream

Adiciona a string como valor de salt para a função de hash MD5 da diretiva sticky nos modos cookie e route. A string pode conter variáveis, por exemplo, $remote_addr:

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

    sticky cookie cookie_name;
    sticky_secret my_secret.$remote_addr;
}

O salt é anexado ao valor sendo hasheado; para verificar o mecanismo de hash independentemente:

$ 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 HTTP 502 para o cliente se o ID 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 HTTP Upstream mostra se uma requisição trouxe dados de sessão e se chegou ao servidor vinculado. O próprio módulo http_upstream_sticky suporta as seguintes variáveis integradas:

$sticky_sessid (PRO)#

Usada com remote_action em sticky; armazena o ID de sessão inicial obtido de lookup.

$sticky_sid (PRO)#

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