API Gateway における API リクエストエラーが低頻度のネットワークエラーであるかを判別するための方法を教えてください

困っていた内容

API Gateway で 5xx エラーが発生していることを確認しました。

ネットワークの問題等で一時的に 5xx エラーが発生している低頻度な事象としての可能性も考えられますが、低頻度なネットワークエラーであるかを判別するための調査方法についてあれば教えてください。

どう対応すればいいの?

当該事象発生時間帯における、API Gateway の 5XXError、Count メトリクスについてお調べいただくことで、低頻度なネットワークエラーであるかを判別することができます。

• Amazon API Gateway のディメンションとメトリクス - Amazon API Gateway

5XXError

指定された期間に取得されたサーバー側エラーの数。 Sum 統計は、このメトリクス、つまり、指定された期間内の 5XXError エラーの合計数を表します。Average 統計は、5XXError のエラー率 (5XXError エラーの合計数をその期間のリクエストの合計数で割った値) を表します。分母は Count メトリクス (下記) に対応します。

Unit: Count

---

Count

指定期間内の API リクエストの合計数。 SampleCount 統計は、このメトリクスを表します。

Unit: Count

例えば、当該事象発生時間帯における API リクエスト数が 20000 件、5xx エラー数が 12 件 の場合、エラー発生率は 0.06% 【(12 / 20000) × 100】程となり、低頻度で発生した状況であることを確認することができます。

上記のように、API リクエストの数が、受信するエラーの数よりも大幅に多い場合は、一時的なネットワークの問題が発生している可能性が考えられるため、再試行（リトライ）で対処を行うなどご検討ください。

• API Gateway の「エンドポイントとの通信中にネットワークエラーが発生しました」というエラーを解決する | AWS re:Post

API リクエストの数が、受信するエラーの数よりも大幅に多い場合は、一時的なネットワークの問題が発生している可能性があります。これらの問題を解決するには、「低頻度のネットワークエラーを解決する」のセクションのステップに従います。

解決方法

低頻度のネットワークエラーを解決する

失敗したリクエストには、エクスポネンシャルバックオフを使用するリトライを使用します。

参考資料

• Amazon API Gateway のディメンションとメトリクス - Amazon API Gateway

• API Gateway の「エンドポイントとの通信中にネットワークエラーが発生しました」というエラーを解決する | AWS re:Post