冒頭まとめ
Kubernetes で 502 Bad Gateway を見る場面は、利用者向けの通信を取り次ぐ Ingress の制御役に集中します。kubectl の操作で 502 が出ることは、通常ありません。API サーバーが時間切れで打ち切る場合は 504 になり、応答できる相手が居ない場合は 503 になるためです。したがって 502 を見たら、まずコンテナへの通信経路の話だと考えて構いません。
502 の意味は、取り次いだ側が転送先から正しい応答を得られなかった、ということです。ここで重要なのは、転送先そのものは選べているという点です。選べていなければ、そもそも転送する相手が居ないので別のエラーになります。多くの制御役は、対象の転送先が1つも無い場合に 503 を返します。
したがって切り分けの第一歩は、502 と 503 のどちらが出ているかを見ることです。503 なら、転送先の一覧が空です。準備完了の判定が通っていないか、選択の条件が合っていないかのどちらかです。502 なら、一覧には相手が居るのに、その相手との通信が成立していません。
502 の原因は、制御役の土台になっているソフトウェアの作りから、3系統に整理できます。接続そのものを拒否された場合、応答の見出し部分が大きすぎて扱えなかった場合、そして応答を渡し終える前に切られた場合です。ログの文言でこの3つは区別できます。
エラーの概要
制御役のログには、要求ごとの記録と、失敗の理由が残ります。接続を拒否された場合の記録は次の形です。
connect() failed (111: Connection refused) while connecting to upstream,
client: 10.1.0.5, server: example.com, request: "GET /api HTTP/1.1",
upstream: "http://10.2.3.4:8080/api"
応答の見出し部分が大きすぎる場合は、別の文言になります。
upstream sent too big header while reading response header from upstream,
client: 10.1.0.5, server: example.com, request: "GET /api HTTP/1.1"
このとき記録に残る転送先の番号を確認してください。ここに出ている番号が、自分が意図したコンテナの番号と違っていれば、原因は設定の食い違いです。
まず最初に:502と503を区別し、転送先の一覧を見る
第一に、返っているのが 502 か 503 かを確認します。503 なら転送先が空なので、以下の原因の話ではありません。
第二に、転送先の一覧を直接確認します。ここに何が並んでいるかで、次に見る場所が決まります。
kubectl get endpointslices -n example -l kubernetes.io/service-name=my-service
kubectl describe service my-service -n example
一覧に並んでいる番号が、コンテナが実際に待ち受けている番号と一致しているかを確かめます。ここがずれていると、接続の拒否として現れます。
第三に、制御役のログから、失敗の文言を取り出します。3系統のどれに当たるかで、対処が決まります。
kubectl logs -n ingress-nginx -l app.kubernetes.io/name=ingress-nginx --tail=200 \
| grep -E "connect\(\) failed|too big header|closed connection"
よくある原因と解決手順
原因1:転送先の番号が実際と違う
最も多い形です。定義した番号と、コンテナが実際に待ち受けている番号が食い違っていると、接続を拒否されます。準備完了の判定が別の番号を見ている場合、判定は通るのに通信は失敗する、という状態にもなります。
Before(定義と実態がずれている):
apiVersion: v1
kind: Service
metadata:
name: my-service
spec:
selector:
app: web
ports:
- port: 80
targetPort: 8080 # コンテナは 3000 で待ち受けている
After(実態に合わせる):
- port: 80
targetPort: 3000
実際に待ち受けている番号は、コンテナの中から確認できます。
kubectl exec -n example deploy/my-app -- sh -c "netstat -tnl 2>/dev/null || ss -tnl"
制御役を通さずに、直接届くかどうかも確かめてください。ここで失敗するなら、原因は制御役ではありません。
kubectl run tmp --rm -it --image=curlimages/curl --restart=Never -- \
curl -sS -o /dev/null -w "status:%{http_code}\n" http://my-service.example.svc.cluster.local/
原因2:応答の見出し部分が大きすぎる
too big header の文言が出る場合です。認証の情報を大きな見出しに載せる構成で起きやすく、利用者によって成功したり失敗したりするのが特徴です。情報の量が人によって違うためです。
制御役には、この大きさを調整する指定が用意されています。個別の設定として書けます。
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: my-ingress
annotations:
nginx.ingress.kubernetes.io/proxy-buffer-size: "8k"
spec:
rules:
- host: example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: my-service
port:
number: 80
全体に適用したい場合は、制御役の設定にまとめて指定します。値は、実際の見出しの大きさを見て決めてください。むやみに大きくすると、接続あたりの使用量が増えます。
原因3:応答を渡し終える前に切られている
コンテナ側が、応答の途中で接続を閉じた場合です。処理に時間がかかってコンテナ側の待ち時間が先に尽きた、コンテナが終了処理に入った、資源の上限に達して落ちた、といった状況が候補になります。
まず、該当の時刻にコンテナが再起動していないかを確認します。
kubectl get pods -n example -o wide
kubectl describe pod -n example <ポッド名> | grep -A5 "Last State"
再起動の回数が増えていれば、原因は通信ではなくコンテナ側です。資源の上限に達して終了させられている場合、終了の理由にその旨が残ります。
更新の最中にだけ出る場合は、終了処理と通信の切り離しの順序が問題です。終了の合図を受けてから実際に止まるまでの猶予を確保し、その間に転送先の一覧から外れるようにします。
原因4:準備完了の判定と実態が合っていない
判定が通っているのに実際には応答できない、という状態です。判定先のパスが、実際の処理と無関係な場所を指している場合に起きます。
kubectl get pod -n example <ポッド名> \
-o jsonpath='{.spec.containers[*].readinessProbe}' | python3 -m json.tool
判定は、実際に処理を担う部分まで到達するパスに向けてください。静的なファイルを返すだけのパスでは、背後の準備が整っていなくても通ってしまいます。
補足:似ているが別のもの
転送先が1つも無い場合は 503 です。準備完了の判定が通っていないか、選択の条件がコンテナの名札と一致していない場合にこうなります(Kubernetes の 503 の記事)。502 との違いは、相手が居るかどうかです。
API サーバーが時間切れで打ち切った場合は 504 で、文言も定型のものが付きます(Kubernetes の 504 の記事)。kubectl の操作で 502 が出た場合は、クラスタの前段に別の中継役が挟まっていることを疑ってください。
処理そのものが失敗した場合は 500、対象が見つからない場合は 404、権限が足りない場合は 403 です(Kubernetes の 500 の記事、404 の記事、403 の記事)。
制御役の土台になっているソフトウェアそのものの挙動は、別記事で扱っています(Nginx の 502 の記事)。文言の意味を細かく追う場合はそちらも参照してください。
切り分けの順序
- 502 か 503 かを確認する。503 なら転送先が空なので、別の調査になる。
- 転送先の一覧を直接見る。並んでいる番号が、実際に待ち受けている番号と一致するかを確かめる。
- 制御役のログから失敗の文言を取り出し、3系統のどれかに振り分ける。
- 接続の拒否なら、定義した番号と実態の食い違いを疑う。
- 見出しが大きすぎる場合は、大きさの指定を調整する。利用者によって成否が分かれるのが特徴。
- 途中で切られている場合は、コンテナの再起動と終了処理の順序を確認する。
- 制御役を通さずに直接届くかを確かめる。直接なら成功するなら、原因は制御役側の設定にある。
確認コマンド集
# 1. 転送先の一覧を確認する(空なら 503 の話)
kubectl get endpointslices -n example -l kubernetes.io/service-name=my-service
# 2. サービスの定義と実際の番号を突き合わせる
kubectl describe service my-service -n example
kubectl exec -n example deploy/my-app -- sh -c "netstat -tnl 2>/dev/null || ss -tnl"
# 3. 制御役のログから失敗の文言を取り出す
kubectl logs -n ingress-nginx -l app.kubernetes.io/name=ingress-nginx --tail=200 \
| grep -E "connect\(\) failed|too big header|closed connection"
# 4. 制御役を通さずに直接届くかを確かめる
kubectl run tmp --rm -it --image=curlimages/curl --restart=Never -- \
curl -sS -o /dev/null -w "status:%{http_code}\n" http://my-service.example.svc.cluster.local/
# 5. コンテナの再起動と終了理由を確認する
kubectl get pods -n example
kubectl describe pod -n example <ポッド名> | grep -A5 "Last State"
# 6. 準備完了の判定の設定を確認する
kubectl get pod -n example <ポッド名> \
-o jsonpath='{.spec.containers[*].readinessProbe}' | python3 -m json.tool
Editor’s Note
502 と 503 の区別は、単なる分類の話ではありません。この2つは、調べるべき対象がまったく違います。503 は「相手が居ない」ので、見るのは準備完了の判定と名札の条件です。502 は「相手は居るが通じない」ので、見るのは番号と応答の中身です。同じ画面の裏で、まったく別の作業が待っています。
そして厄介なのは、この2つが入れ替わることです。準備完了の判定が通った直後は 503 から 502 に変わり、コンテナが落ちれば 502 から 503 に戻ります。更新の最中に両方が混ざって出るのは、そのためです。一方だけを見て原因を決めると、もう一方の時間帯を取りこぼします。
もう1つ、原因2の見出しの大きさは、切り分けを誤りやすい形です。すべての利用者で失敗するなら設定を疑いますが、この形では一部の利用者だけが失敗します。「特定の人だけ動かない」という報告が来たとき、権限の問題を疑うのが自然です。しかし実際には、その人の認証の情報が他より少しだけ大きい、というだけのことがあります。ログの文言を見れば一目で分かるので、推測の前に文言を確認してください。
免責事項:本記事の内容は、執筆時点の公開情報をもとに作成したものです。ソフトウェアの仕様は予告なく変更されることがあります。最新の情報は各ツールの公式サポートページをご確認ください。本記事の情報を利用した結果生じたいかなる損害についても、著者および運営者は責任を負いかねます。
この記事でエラーは解決しましたか?