ALBターゲットグループのヘルスチェクのためのnginx設定

ALBに登録したターゲットグループのターゲット（EC2）に対するヘルスチェックを行う際に、ターゲット側のnginxの設定で少し詰まったので記録。

前提

• ターゲットグループ
  • ALBからHTTP:80でリクエストを受け付けている
• EC2
  • アプリケーションサーバーをポート8080で起動している
  • ヘルスチェックのパスは/api/ping
  • サーバー内からはhttp://localhost:8080/api/pingでアクセス可能
  • 今回はサーバー内でアプリが正常に起動した状態をもってhealthyとしています

ターゲットグループのヘルスチェック設定

• プロトコル : HTTP
• パス : /ping

デフォルト設定について

• HealthCheckProtocol : ヘルスチェックのプロトコル。ALBの場合はHTTPまたはHTTPS (デフォルトはHTTP)
• HealthCheckPort : ヘルスチェックのポート。（デフォルトはターゲットグループで設定しているポート）
• HealthCheckPath : ヘルスチェックのパス。（デフォルトは/）

ref : https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/application/target-group-health-checks.html

EC2のnginx設定

nginx.conf

server {
    listen       80 default_server;

    # Health Check By ALB
    location = /ping {
        access_log  off;
        proxy_pass http://localhost:8080/api/ping;
    }
}    

1. ターゲットグループの設定により、ターゲットに対してhttp://{private-ip}/pingへGETリクエストが送信されます（private-ipはターゲットの内部IP）
2. NginxはHostヘッダprivate-ipをdefault_serverに向けます（他にserver_name {private-ip}の設定を行っていない場合）
3. http://localhost:8080/api/pingへリダイレクトされます

これにより設定が完了し、ターゲットEC2のアプリケーションのping結果を元にヘルスチェックができるようになりました。