Module ngx_http_upstream_hc_module

設定例
ディレクティブ
     health_check
     match

The ngx_http_upstream_hc_module module allows enabling periodic health checks of the servers in a group referenced in the surrounding location. The server group must reside in the shared memory.

If a health check fails, the server will be considered unhealthy. いくつかのヘルスチェックがサーバの同じグループに定義されている場合、いずれかのチェックの一つの失敗により対応するサーバが健康では無いと見なされるでしょう。Client requests are not passed to unhealthy servers and servers in the “checking” state.

ヘルスチェックで使われる場合に、ほとんどの変数が空の値を持つことに注意してください。

このモジュールは商用許可の一部として利用可能です。

設定例

upstream dynamic {
    zone upstream_dynamic 64k;

    server backend1.example.com      weight=5;
    server backend2.example.com:8080 fail_timeout=5s slow_start=30s;
    server 192.0.2.1                 max_fails=3;

    server backup1.example.com:8080  backup;
    server backup2.example.com:8080  backup;
}

server {
    location / {
        proxy_pass http://dynamic;
        health_check;
    }
}

With this configuration, nginx will send “/” requests to each server in the backend group every five seconds. もしなんらかの送信エラーまたはタイムアウトが起こるか、またはプロキシされたサーバがステータスコード 2xxまたは3xx 以外を送信した場合、ヘルスチェックは失敗しサーバは健康ではないと見なされるでしょう。

ヘルスチェックは応答のステータスコード、特定のヘッダフィールドとその値、そしてボディの内容をテストするように設定することができます。Tests are configured separately using the match directive and referenced in the match parameter of the health_check directive:

http {
    server {
    ...
        location / {
            proxy_pass http://backend;
            health_check match=welcome;
        }
    }

    match welcome {
        status 200;
        header Content-Type = text/html;
        body ~ "Welcome to nginx!";
    }
}

This configuration shows that in order for a health check to pass, the response to a health check request should succeed, have status 200, and contain “Welcome to nginx!” in the body.

ディレクティブ

構文: health_check [parameters];
デフォルト: -
コンテキスト: 場所

取り囲んでいるlocation内で参照されるgroup の中でサーバの定期的なヘルスチェックを有効にします。

次の任意のパラメータがサポートされます:

interval=time
sets the interval between two consecutive health checks, by default, 5 seconds.
jitter=time
sets the time within which each health check will be randomly delayed, by default, there is no delay.
fails=number
sets the number of consecutive failed health checks of a particular server after which this server will be considered unhealthy, by default, 1.
passes=number
sets the number of consecutive passed health checks of a particular server after which the server will be considered healthy, by default, 1.
uri=uri
defines the URI used in health check requests, by default, “/”.
mandatory
sets the initial “checking” state for a server until the first health check is completed (1.11.7). Client requests are not passed to servers in the “checking” state. If the parameter is not specified, the server will be initially considered healthy.
match=name
specifies the match block configuring the tests that a response should pass in order for a health check to pass. By default, the response should have status code 2xx or 3xx.
port=number
defines the port used when connecting to a server to perform a health check (1.9.7). By default, equals the server port.

構文: match name { ... }
デフォルト: -
コンテキスト: http

ヘルスチェックリクエストへの応答の検証に使われる名前付きのテストセットを定義します。

次の項目を応答の中でテストすることができます:

status 200;
ステータスが200
status ! 500;
ステータスが500では無い
status 200 204;
ステータスが200または204である
status ! 301 302;
ステータスが301または302では無い
status 200-399;
ステータスが200から399の範囲にある
status ! 400-599;
ステータスが400から599の範囲に無い
status 301-303 307;
ステータスが301,302,303または307のいずれかである

header Content-Type = text/html;
ヘッダーに値がtext/htmlである"Content-Type"が含まれる
header Content-Type != text/html;
ヘッダーにtext/html以外の値を持つ"Content-Type"が含まれる
header Connection ~ close;
ヘッダーに正規表現closeにマッチする値を持つ"Connection"が含まれる
header Connection !~ close;
ヘッダーに正規表現closeにマッチしない値を持つ"Connection"が含まれる
header Host;
ヘッダーに"Host"が含まれる
header ! X-Accel-Redirect;
ヘッダーに"X-Accel-Redirect"が無い

body ~ "Welcome to nginx!";
ボディが正規表現"Welcome to nginx!"にマッチする
body !~ "Welcome to nginx!";
ボディが正規表現"Welcome to nginx!"にマッチしない

いくつかのテストが指定された場合は、応答は全てのテストにマッチした時にのみマッチします。

応答ボディの最初の256kだけがテストされます。

例:

# status is 200, content type is "text/html",
# and body contains "Welcome to nginx!"
match welcome {
    status 200;
    header Content-Type = text/html;
    body ~ "Welcome to nginx!";
}

# status is not one of 301, 302, 303, or 307, and header does not have "Refresh:"
match not_redirect {
    status ! 301-303 307;
    header ! Refresh;
}

# status ok and not in maintenance mode
match server_ok {
    status 200-399;
    body !~ "maintenance mode";
}

TOP
inserted by FC2 system