Docker環境で502 Bad Gatewayエラーを解消する方法

Docker環境でNginxをリバースプロキシとして使用している際に、502 Bad Gatewayエラーが発生することがある。このエラーは、通常、Nginxがバックエンドサーバ（例えば、PHP-FPMやNode.js）からのレスポンスを処理できない場合に発生する。この記事では、このエラーを解消するためにdocker-compose.ymlに設定を追加した解決方法を紹介する。

エラーの原因

502 Bad Gatewayエラーが発生する一般的な原因は次の通り。

バックエンドサーバのレスポンスサイズが大きい:
- Nginxのproxy_buffer_sizeやproxy_buffersのデフォルト設定が小さすぎて、バックエンドサーバからのレスポンスを処理できない。
バックエンドサーバが停止している:
- PHP-FPMやNode.jsが起動していない、またはクラッシュしている。
ネットワーク接続の問題:
- コンテナ間の通信に問題がある。

この記事では、Nginxのバッファ設定不足が原因の場合の解決方法を説明する。

解決方法

1. docker-compose.ymlへの設定追加

docker-compose.ymlでNginxサービスの環境変数としてPROXY_BUFFERSとPROXY_BUFFER_SIZEを設定する。

以下は、Nginxコンテナに必要な設定を追加した例。

version: '3.8'
services:
  nginx:
    image: nginx:latest
    container_name: nginx
    ports:
      - "80:80"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf
    environment:
      PROXY_BUFFERS: "4 256k"
      PROXY_BUFFER_SIZE: "128k"
    depends_on:
      - app
  app:
    image: php:7.4-fpm
    container_name: app
    volumes:
      - ./app:/var/www/html

2. Nginxの設定に環境変数を適用

Nginxの設定ファイル（例: nginx.conf）に環境変数を利用するように設定する。

http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;

    # 環境変数を使用した設定
    server {
        listen 80;

        location / {
            proxy_pass http://app:9000;  # バックエンドサーバへのプロキシ
            proxy_buffer_size $PROXY_BUFFER_SIZE;
            proxy_buffers $PROXY_BUFFERS;
            proxy_busy_buffers_size $PROXY_BUFFER_SIZE;
        }
    }
}

3. コンテナを再起動

変更を反映するために、Docker Composeでコンテナを再起動する。

docker-compose down
docker-compose up -d

設定の詳細

PROXY_BUFFERS:
- バッファの数とサイズを指定する。
- 例: "4 256k"は4つのバッファをそれぞれ256KBで確保する。
PROXY_BUFFER_SIZE:
- 1つのレスポンスヘッダ用のバッファサイズを指定する。
- 例: "128k"は128KBのバッファサイズを指定する。

これらの設定を適切に増加させることで、大きなレスポンスデータを処理できるようになる。

502 Bad Gateway解消の確認

設定変更後、ブラウザやcurlコマンドを使用してリクエストを送信し、502 Bad Gatewayエラーが解消されているか確認する。

curl -I http://localhost

正常であれば、HTTP/1.1 200 OKが返ってくる。

メリットと注意点

メリット

バッファサイズを調整することで、大きなレスポンスデータを処理可能にする。
簡単な設定変更でエラーを解消できる。

注意点

バッファサイズを過剰に大きくすると、Nginxのメモリ使用量が増加する。
設定を適切にチューニングし、実際のデータ量に合わせることが重要。