第34章 レスポンスコードの追跡

本チュートリアルでは、3scale システムでレスポンスコードのログを設定して使用する方法について説明します。

API プロダクトからのレスポンスコードを追跡することで、顧客の API の使用状況を把握し、サーバーに問題がないかどうかをリアルタイムで確認することができます。

レスポンスコードの追跡機能を有効にするには、Docker または OpenShift デプロイメントを使用して APIcast ゲートウェイを起動する際に、APICAST_RESPONSE_CODES 環境変数を 1 または true に設定します。

有効にすると、APIcast ゲートウェイは、承認呼び出しに関してアップストリームサービスによって返される API レスポンスの HTTP ステータスコードを取得し、それらを Service Management API に送信します (authrep コール)。例:

https://su1.3scale.net/transactions/authrep.xml?service_token={SERVICE_TOKEN}&service_id={SERVICE_ID}&user_key={USER_KEY}&usage%5Bhits%5D=1&log%5Bcode%5D=200"

上記の例では、log[code]=200 が送信されています (API が 200 のステータスコードと共に応答した)。

インテグレーションを確認するには、有効な 3scale クレデンシャルを使用して API プロダクトを呼び出してから、Analytics > Usage のページで呼び出しが正しく報告されたことを確認します。

Usage screen

ここまで問題がなければ、Analytics >Response codes のページに移動します。レスポンス (2xx、4xx、または 5xx) に応じて色分けされた最新トラフィックのグラフが表示されるはずです。

response codes screen

グラフツールにより、レスポンスコードの履歴を表示することができます。異なる期間および細かさのレベルでレスポンスコードの統計を確認することもできます。期間選択バーをクリックして、ニーズに合った期間と細かさを定義するだけです。