第31章 API の解析

本章は、API の解析をカスタマイズし、最も使用されているアプリケーションや時間と共に傾向が変化する様子を確認する等、把握すべき項目を追跡するのに役立つように意図されています。トラフィックを管理し、ピーク時に対応し、API に最も多くのリクエストを送信しているユーザーを特定するためには、ご自分の API がどのように使用されているかを知ることが重要なステップとなります。

3scale では、API 解析の追跡に使用するメソッドおよびメトリクスを、以下のレベルで定義することができます。

  • プロダクト: Hits メトリクスは、Hits 自身および対応するメソッドにマッピングされたヒット、ならびにバックエンドレベルの Hits メトリクスおよびそのメソッドにマッピングされたすべてのヒットをカウントします。
  • バックエンド: 3scale では、メソッドおよびメトリクスが API バックエンドに登録されます。これにより、メソッドおよびメトリクスがバックエンドを使用する各プロダクトに属するかのように機能します。バックエンドレベルのメトリクスの制限および課金ルールを、プロダクトレベルで定義されるアプリケーションプランに設定することができます。
  • アプリケーション: 3scale で作成した各アプリケーションの解析レポートを取得することができます。

31.1. 前提条件

本章の手順を実施するには、スタートガイド の手順を完了している必要があります。

本章では、既存の 3scale コードプラグインのいずれかを使用してインテグレーションを行っていると仮定しています。他のインテグレーション方法でも、類似の作業フローをたどることができます。利用可能なインテグレーションオプションの詳細については、API ゲートウェイの管理の APIcast の運用 の章を参照してください。