第29章 API アクセスを管理および最適化するための 3scale API 解析の実装
3scale API 解析を実装して API アクセスを管理および最適化することで、時間と共に変化する使用状況の傾向などを追跡することができます。トラフィックを管理し、ピーク時に対応し、API に最も多くのリクエストを送信しているユーザーを特定するためには、ご自分の API がどのように使用されているかを知ることが重要なステップとなります。
3scale では、以下のレベルで定義可能なメソッドおよびメトリクスに関する API 解析を収集します。
- プロダクト:Hits は、API へのトラフィックを追跡する組み込みのメトリクスです。追加のメトリクスを作成して、解析を取得する API にメソッドを指定することができます。
- バックエンド:3scale では、メソッドおよびメトリクスが API バックエンドに登録されます。これにより、メソッドおよびメトリクスが API バックエンドを使用する各プロダクトに属するかのように機能します。バックエンドレベルのメトリクスの制限および課金ルールを、プロダクトレベルで定義されるアプリケーションプランに設定することができます。
- アプリケーション:3scale で作成された各アプリケーションの解析レポートを取得することができます。
前提条件
スタートガイドの手順 を完了している。
スタートガイド を使用して、既存の 3scale コードプラグインのいずれかを使用してインテグレーションを実施します。
- あるいは、他のインテグレーション方法の類似作業フローに従います。利用可能なインテグレーションオプションの詳細は、API ゲートウェイの管理の APIcast の運用 の章を参照してください。
29.1. API の使用状況を把握する 3scale API メトリクスおよびメソッド
3scale は、API プロダクトの統計値に関して無限にスケーラブルなデータリポジトリーとして機能します。メトリクスおよびメソッドを使用して API プロダクトの統計値を取得することで、API へのアクセスを最適に管理するために必要な情報を取得することができます。以下に例を示します。
- Hits/transactions: API プロダクトへの呼び出しの数。Hits は、すべての API にデフォルトでメトリクスとして含まれています。Hits は、API プロダクトへの全呼び出し数とすることも、API プロダクトの個々のメソッドにブレークダウンすることもできます。
- Data transfer: API プロダクトを通じてアップロードおよびダウンロードされたデータ量 (MB/GB 単位)
- CPU hours: API プロダクトへの呼び出しに関連する処理時間 (またはその他の内部リソース)
- Results returned: 返されているレコードまたはデータオブジェクト数のカウント
- Disk storage: アカウントにより使用されているディスクストレージの合計
ご自分の API プロダクトに関連するより多くのメトリクスを追跡することができます。時間の経過と共に増加する数量であれば、3scale では任意の数のメトリクスおよびメソッドを追加することができます。
使用するメトリクスを選択したら、プロダクトおよびバックエンドへのメトリクスの追加 に記載の手順に従って、管理ポータルにそれらのメトリクスを登録します。
選択したプロダクトまたはバックエンドにメトリクスおよびメソッドを追加することができます。それらに分かりやすい名前およびシステム名を設定します (3scale はこれらの名前をプラグイン設定で使用します)。メソッドおよびメトリクスの作成に関する詳細は、使用状況の詳細を把握するためのメソッドの指定およびメトリクスの追加 を参照してください。
