第34章 API に対する 3scale レスポンスコードログの設定および評価

クライアントが API をどのように使用しているかを確認し、サーバーが想定どおりに実行されているかどうかをリアルタイムで確認するには、3scale のレスポンスコードログを設定して使用します。

手順

  • 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 のページで呼び出しが正しく報告されたことを確認します。

注記
  • 応答コード追跡は、すべての応答を正確にカウントすることを意図したものではありません。
  • このビューの価値は、一定期間の傾向を視覚的に表現することです。
  • Response Code Tracking と 3scale Auth Caching モード: None は、サポートされている組み合わせではありません。
Usage screen

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

response codes screen

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