ELBなどでhealth checkをする際に使える便利なempty_gif（Nginx）

##いつ使うの？

EC2でELB（“Elastic Load Balancing”：ロードバランサー）を利用すると、HealthCheck（ヘルスチェック）が求められ何かしらのファイルが必要になります。そんな時に便利な「empty_gif」というnginxの標準モジュールが持つ便利機能があります。

nginx（HttpEmptyGifModuleJa）

##empty_gifとは？

nginxの標準モジュールが持つ機能で、nginxがメモリに保持している1x1ピクセルの透過 GIF ファイルをクライアントに返すことができます。

書き方

nginx.conf

location / {
    proxy_pass http://mossmoss.com;
    break;
}

location = /healthcheck.html {
    empty_gif;
    break;
}

##Nginxのアクセスログ

171.33.38.moss - - [10/Mar/2024:12:34:10 +0000] "GET /healthcheck.html HTTP/1.1" 200 43 "-" "ELB-HealthChecker/1.0"
227.33.18.moss - - [10/Mar/2024:12:34:16 +0000] "GET /healthcheck.html HTTP/1.1" 200 43 "-" "ELB-HealthChecker/1.0"
153.33.18.moss - - [10/Mar/2024:12:34:19 +0000] "GET /healthcheck.html HTTP/1.1" 200 43 "-" "ELB-HealthChecker/1.0

上記のようにaccess_logに残したくない場合は、「access_log off」を足すとよいでしょう。

##書き方

nginx.conf

location = /healthcheck.html {
    empty_gif;
    access_log off;
    break;
}

便利。

※ELB HealthCheckのPing Pathを/healthcheck.htmlに設定
※HealthCheckは、アプリケーションに到達できて、使用可能で、機能していることを確認する行為