直近の API トラフィックのモニタリング

[Recent] ダッシュボードを使用すると、組織のすべての API プロキシとターゲット サービスの過去 1 時間の API トラフィックをモニタリングできます。API モニタリングのデータは、詳細なリストまたはヒートマップとして表示できます。次のセクションで、次の各ビューについて説明します。

リストビューを使用する

リストビューには、最近トラフィックが発生した、組織の API プロキシとターゲット サービスの要約情報が表示されます。

リストビューを詳しく見る

リストビューを表示するには、Edge UI で [Analyze] > [API Monitoring] > [Recent] を選択します。

リストビューはデフォルトで表示されます。[Recent] ダッシュボードで をクリックすることで、いつでもリストビューに戻ることができます。

[Recent] ページ

図でハイライト表示されているように、リストビューでは以下を行うことができます。

  • 過去 1 時間にトランザクションが発生した組織の、すべての API プロキシとターゲット サービスの要約情報を表示できます。API プロキシとターゲット サービスは、リージョン別、環境別にリストされます(より広範な履歴ビューについては、API Monitoring データでのトレンドの特定をご覧ください)。
  • アラートがある API プロキシとターゲット サービスを素早く識別できます(アラートの設定について詳しくは、アラートと通知を設定するをご覧ください)。
  • リスト内の API プロキシまたはターゲット サービスの名前をクリックすることで、右ペインに詳細データを表示できます。
  • 現在のコンテキストを使用して、以下のタスクを素早く実行します(現在選択されているコンテキストに適用できない場合、オプションはグレー表示されます)。

    • カスタム レポートを作成し、分割項目を追加できます。 をクリックします。
    • アラートを作成し、アラート条件の追加や通知の設定、アラートに基づいたカスタム レポートの生成を行うことができます。
    • [Timeline] ダッシュボードまたは [Investigate] ダッシュボードで現在のコンテキストを表示できます。[More] メニュー をクリックし、[View in Timeline] または [View in Investigate] をクリックします。
  • 名前か URL(https://acme.com/api など)でリストビューを検索できます。検索ボックスに関連する文字列の全体または一部を入力します。[Proxy]、[Targets]、[Region] フィールドでコンテンツを検索できます。

    : [Alerts only] フィルタを選択すると、アラートがある API プロキシまたはターゲット サービスのみ検索結果にリストされます。

  • 必要に応じて、ページの自動更新を有効または無効にできます。

  • リストにターゲット サービスの詳細を表示できます。またこれを非表示にすることもできます。

アラートがある API プロキシとターゲット サービスを特定する

リストビューを表示すると、赤色の警告アイコン と赤色の左の枠線により、どの API プロキシとターゲット サービスにアラートがあるかが示されます。

[Alerts only] をクリックすると、アラートがある API プロキシまたはサービス ターゲットのみ表示されます。

アラートのみ

4xx および 5xx エラーの数、および全体的なエラー率をひと目で確認するには、テーブル内の数値にマウスポインタを合わせます。

API プロキシまたはターゲット サービスの詳細データを表示する

API プロキシまたはターゲット サービスの詳細データを表示するには、リストビューでその名前をクリックします。右ペインに詳細データが表示されます。

詳細ビュー

次のタブをクリックすると、詳細情報が表示されます。

また、現在のコンテキストを使用して、次のタスクを素早く実行できます。

: 現在選択されているコンテキストに適用されないオプションはグレー表示されます。

  • カスタム レポートを作成し、分割項目を追加できます。 をクリックします。
  • アラートを作成し、アラート条件の追加や通知の設定、アラートに基づいたカスタム レポートの生成を行うことができます。[More] メニュー をクリックし、[Create Alert] をクリックします。
  • [Timeline] ダッシュボードまたは [Investigate] ダッシュボードで現在のコンテキストを表示できます。[More] メニュー をクリックし、[View in Timeline] または [View in Investigate] をクリックします。

Details

[Details] タブでは、指定のタイムラインのトラフィック データを素早く確認できます(前の図を参照)。データには次の情報が含まれます。

詳細 説明
Total Traffic トランザクションの合計数。
Total Errors エラーの合計数。
Total Error Rate エラーとなったトラフィックのパーセンテージ(Total Errors/Total Traffic)。

: API Monitoring では、設定したアラート条件とこのパーセンテージが比較されます。合計エラー率がしきい値を超えると、UI にアラート インジケーターが表示されます。

Average TPS 1 秒あたりの平均トランザクション数。
Total Latency (P99) 5 分のローリング ウィンドウで計算された、99 パーセンタイルでの合計レスポンス レイテンシ値。
: API プロキシに対してのみ表示されます。
Target Latency (P99) 5 分のローリング ウィンドウで計算された、99 パーセンタイルでのターゲット レスポンス レイテンシ値。
: API プロキシに対してのみ表示されます。
Error Source 発生した API プロキシ関連のエラー(4xx と 5xx)の内訳と合計パーセンテージ。

[Trends] タブには、選択したコンポーネントに関する次のグラフが表示されます。

  • 4xx エラーと 5xx エラーのエラー率
  • トラフィック(TPS)
  • 合計レイテンシ(ミリ秒)
  • すべてのターゲット レイテンシ

グラフの各ポイントにカーソルを合わせると、各ポイントのエラー率、合計トラフィック数、レイテンシをすぐに確認できます。

Trends

Logs

[Logs] タブで、4xx、5xx、すべてのエラーでフィルタし、API プロキシ、ターゲット サービス(ご使用のサービス)、Apigee(Apigee インフラストラクチャ)によってエラーの原因を絞り込みます。

Logs

エラーをクリックすると、ログダイアログが開き、その詳細がリストに展開されます。

Logs

ヒートマップを使用する

ヒートマップでは、色付きのブロックが表示され、どの環境にアラートがあるか識別できます。

  • 緑色は、アラート条件のしきい値を超えていないことを示します。
  • 赤色は、アラート条件のしきい値を超えて、アラートがトリガーされたことを示します。

ヒートマップを詳しく見る

[Recent] ページで をクリックすると、次の図のようなヒートマップが表示されます。

ヒートマップ

前の図に示されているように、ヒートマップでは以下を行うことができます。

  • アラートがある API プロキシとターゲット サービスを素早く識別できます(アラートの設定について詳しくは、アラートと通知を設定するをご覧ください)。
  • プルダウン リストからコンポーネントを選択することで、またはボックスをダブルクリックしてドリルダウンすることで、表示をフィルタリングできます。[Proxies] プルダウン リストと [Targets] プルダウン リストでは、コレクションを使用してフィルタリングできます。次に例を示します。
  • ヒートマップ内のブロックをクリックすることで、右ペインに詳細データを表示できます。
  • 現在のコンテキストを使用して、以下のタスクを素早く実行します(現在選択されているコンテキストに適用できない場合、オプションはグレー表示されます)。

    • カスタム レポートを作成し、分割項目を追加できます。 をクリックします。
    • アラートを作成し、アラート条件の追加や通知の設定、アラートに基づいたカスタム レポートの生成を行うことができます。[More] メニュー をクリックし、[Create Alert] をクリックします。
    • [Timeline] ダッシュボードまたは [Investigate] ダッシュボードで現在のコンテキストを表示できます。[More] メニュー をクリックし、[View in Timeline] または [View in Investigate] をクリックします。
  • [scaled by] を [logarithmic] または [linear] に設定することで、ヒートマップの表示スケールを設定できます。[linear] では、全体的なトラフィック比率に応じてボックスのサイズが調整されます。たとえば、200 件の呼び出しがあるプロキシのサイズは、100 件の呼び出しがあるプロキシの 2 倍になります。

    ヒートマップの調整

  • 検索ボックスに関連する文字列の全体または一部を入力することで、ヒートマップを検索できます。現在表示されている内容に応じて、リージョン、環境、プロキシ、またはターゲット マップのコンテンツを検索できます。

    : [Alerts only] フィルタを選択すると、アラートがある API プロキシまたはターゲット サービスのみ検索結果にリストされます。

  • 必要に応じて、ページの自動更新を有効または無効にできます。

アラートがある API プロキシとターゲット サービスを特定する

ヒートマップを表示すると、赤色のブロックにより、アラートのある環境、API プロキシ、ターゲット サービスが示されます。アラートの設定について詳しくは、アラートと通知を設定するをご覧ください。

たとえば、次の図では 2 つの環境が示されています。

  • test 環境は赤色です。これは、この環境のトラフィック エラー率が、指定のタイムラインに対して設定したアラート条件のしきい値を超過しているためです。
  • prod 環境は緑色です。これは、この環境のトラフィック エラー率が、指定のタイムラインのアラート条件しきい値を超過していないためです。

ヒートマップ

プルダウン リストからコンポーネントを選択することで表示をフィルタリングできます。また、ボックスをダブルクリックすることで、環境マップから API プロキシマップにドリルダウンすることや、API プロキシマップからその API プロキシのサービス ターゲット マップにドリルダウンすることができます。これにより、アラートがある API プロキシとターゲット サービスを識別できます。

環境 >> プロキシ >> ターゲット

[Alerts only] をクリックすると、現在表示されている内容に応じて、アラートがある環境、API プロキシ、またはサービス ターゲットのみ表示されます。

上位の階層に戻るには、ヒートマップの矢印 をクリックします。

環境、API プロキシ、またはターゲット サービスの詳細データを表示する

環境、API プロキシ、またはターゲット サービスの詳細データを表示するには、ヒートマップで対応するボックスをクリックします。右ペインに詳細データが表示されます。

ヒートマップ

タブにより、リストビューで提供される情報と同じ情報が提供されます。詳細については、次をご覧ください。

また、マップ内のボックスをクリックすると、過去 1 時間の呼び出し数とエラー率をすぐに確認できます。

ヒートマップのツールチップ

[Recent] ダッシュボードからカスタム レポートを作成する

選択した一連の条件に基づいてカスタム レポートを作成します。カスタム レポートが作成された後、必要に応じて、そのカスタム レポートを編集して指標と分割項目を追加または削除できます。たとえば、調査対象を特定のアクセス トークン、デベロッパー アプリ、API プロキシに絞り込むことができます。詳細については、分析指標、分割項目、フィルタのリファレンスをご覧ください。

詳細については、カスタム レポートの作成をご覧ください。

[Recent] ダッシュボードからカスタム レポートを作成するには:

  1. Edge UI で [Analyze] > [API Monitoring] > [Recent] をクリックします。
  2. リストビューまたはヒートマップのフィルタ プルダウンで API プロキシまたはターゲット サービスを選択して、詳細を表示します。 : [Proxies] フィルタと [Targets] フィルタが All に設定されている場合、カスタム レポートは使用できません。

  3. 右隅にある カスタム レポートの作成 をクリックします。

    新しいタブにカスタム レポート ページが表示されます。関連するフィールドにはデータがすでに入力されています。またこのページには、デフォルトの分割項目と指標が含まれます。デフォルトでは、カスタム レポートの名前は API Monitoring Recent Generated です。: カスタム レポートが現在のコンテキストですでに存在する場合、そのレポートが開きます。

  4. 必要に応じてカスタム レポートを編集し、[Save] をクリックします。

  5. リストのレポート名をクリックして、カスタム レポートを実行します。