API 使用状況のモニタリング

このページでは、API 指標を使用して、Google APIs と Google Cloud APIs の使用状況を追跡、理解する方法について説明します。

Google API は、次のことに役立つ詳細な使用状況の指標を生成します。

  • Google API の使用状況を追跡、把握する。
  • アプリケーションと Google API のパフォーマンスをモニタリングする。
  • アプリケーションと Google API の間の問題を検出する。

問題をトラブルシューティングしたり、Google の技術サポートを受けたりすることで、解決にかかる時間を劇的に短縮できます。

Google API が生成する指標は、Google のサイト信頼性エンジニアがサービスの正常性を評価する際に使用する標準シグナルです。これらの指標の対象は、リクエスト数、エラー率、合計レイテンシ、バックエンド レイテンシ、リクエスト サイズ、レスポンス サイズです。API 指標の定義については、Cloud Monitoring のドキュメントをご覧ください。

API 指標は、API ダッシュボードと Cloud Monitoring の 2 か所で表示できます。表示される指標はプロジェクトに固有のものであり、サービスのステータス全体を反映したものではありません。

API ダッシュボードを使用する

API 指標を表示する最も簡単な方法としては、Google Cloud コンソール の API ダッシュボードを使用します。このダッシュボードでは、API 使用に関するすべての指標状況の概要を表示することも、特定の API の使用状況を詳細に調べることもできます。

API 使用状況の概要については:

  1. Cloud Console の [API とサービス] セクションに移動します。デフォルトで、メインの API ダッシュボードが表示されます。このページで、プロジェクトに現在有効にされているすべての API と、次の指標の概要を示すグラフを確認できます。

    • トラフィック: API が有効にされているプロジェクトによって行われる、またはプロジェクトに関する 1 秒あたりのリクエスト数
    • エラー: 有効にされている API に対して行ったすべてのリクエストのうち、エラーが発生したリクエストの割合
    • 中央値のレイテンシ: 有効にされている API に対するリクエストでの中央値のレイテンシ（利用可能な場合）。

特定の API の使用状況の詳細を表示するには、次の手順に従います。

  1. メインの API ダッシュボードに表示される API のリストで、詳細を表示する API を選択します。その API の概要ページに、レスポンス コード別の内訳を示す、詳細なトラフィック グラフが表示されます。

  2. 使用状況に関する情報をさらに詳しく調べるには、[指標を表示] を選択します。 デフォルトでは、事前に作成されている次のグラフが表示されます。ただし、表示できるグラフは他にもあります。

    • レスポンス コード別のトラフィック
    • API メソッド別のエラー数
    • 50 番目、95 番目、99 番目のパーセンタイルにおける全体的なレイテンシ
    • API メソッド別のレイテンシ（中央値）

  3. グラフをさらに追加するには、[グラフを選択] プルダウン メニューから、事前に作成されている追加のグラフを選択します。

Cloud Monitoring の使用

Cloud Monitoring を使用している場合は、API の使用状況をより詳細に把握するため、Metrics Explorer を使用して、利用可能な指標データを詳しく分析できます。Cloud Monitoring はさまざまな指標をサポートしています。このような指標とフィルタや集計を組み合わせることで、アプリケーションのパフォーマンスを詳しく分析できます。たとえば、リクエスト数の指標を HTTP レスポンス コード クラスのフィルタと組み合わせて、一定期間にわたるエラー率を示すダッシュボードを作成したり、Cloud Pub/Sub API に対するリクエストについて、95 番目のパーセンタイルにおけるレイテンシを調べたりできます。