カスタム レポートの作成と管理

カスタム レポートを使用すると、特定の API 指標を掘り下げて、確認が必要な正確なデータを表示できます。Edge に組み込まれている指標および分割項目のいずれかを使用して、カスタム レポートを作成できます。加えて、StatisticsCollector ポリシーを API プロキシに接続して、ユーザー ID またはプロダクト ID、料金、REST アクション、ターゲット バージョン、ターゲット URL、メッセージ長などのカスタム指標を収集できます。

Classic Edge UI を使用してカスタム レポートを作成する方法については、動画をご覧ください。

New Edge エクスペリエンス UI を使用してカスタム レポートを作成する方法については、動画をご覧ください。

カスタム レポートについて

カスタム レポートを作成する場合、表示するデータ(指標)を選択し、意味のある方法でデータをグループ化し(分割項目)、必要に応じて、そのデータの特性(フィルタ)に基づいて返されるデータを制限します。

カスタム レポートに表示されるグラフのタイプを縦棒グラフまたは折れ線グラフとして設定することもできます。次の画像は、API プロキシの分割項目ごとにグループ分けされた 1 秒あたりのトランザクション数の指標のグラフ例を示しています。

  • 縦棒グラフ - 各 API プロキシは、それぞれの縦棒で表されています。

    カスタム縦棒グラフ

  • 折れ線グラフ - 各 API は、それぞれの折れ線で表されています。

    カスタム折れ線グラフ

指標と分割項目の設定

カスタム レポートで選択する指標は、測定するデータを指定します。指標データは、カスタム レポートに表示されるグラフの y 軸で表されます。一般的な指標には、次のようなものがあります。
  • 1 秒あたりのトランザクション数
  • 応答時間
  • ポリシーエラー

一部の指標では、指標に対して実行する集計関数を設定できます。たとえば、応答時間の指標とともに次の集計関数を使用できます。

  • avg: 平均応答時間を返します。
  • min: 最小応答時間を返します。
  • max: 最大応答時間を返します。
  • sum: すべての応答時間の合計を返します。

すべての指標ですべての集計関数がサポートされるわけではありません。指標の名前と各指標でサポートされる関数(sumavgminmax)が示されている表については、指標のドキュメントをご覧ください。

分割項目は、指標データをグループ化する方法を指定します。たとえば、応答時間の指標を表すカスタム レポートを作成するとします。以下を取得するために、API プロダクト、API プロキシ、またはデベロッパーのメールで指標データをグループ化する分割項目を使用できます。

  • API プロダクトあたりの応答時間
  • API プロキシあたりの応答時間
  • デベロッパーのメールあたりの応答時間

分割項目がカスタム レポートのグラフで表示される方法は、グラフのタイプによって異なります。

  • 縦棒グラフ: 分割項目はグラフの X 軸に沿って表示されます。このグラフでは、それぞれの縦棒は分割項目の各値に対応します。
  • 折れ線グラフ: グラフのそれぞれの折れ線は、分割項目の各値に対応し、X 軸は時間を表します。

カスタム指標および分割項目の作成

StatisticsCollector ポリシーを API プロキシに追加して、ユーザー ID またはプロダクト ID、料金、REST アクション、ターゲット バージョン、ターゲット URL、メッセージ長などのカスタム分析データを収集します。データは、Apigee で事前定義されているフロー変数、リクエスト ヘッダー、クエリ パラメータ、ユーザー定義のカスタム変数から取得できます。データが収集されたら、カスタム レポートを作成して、そのデータを表示できます。

カスタム レポートにカスタム分析データを表示する方法は、データ型によって異なります。

  • string データ型の場合は、カスタム レポートで統計データを分割項目として参照します。
  • データ型が数値(integer / float / long / double)の場合、カスタム レポートの統計データは分割項目または指標として参照されます。

カスタム分析データの収集に関する例については、StatisticsCollector ポリシーをご覧ください。

フィルタの設定

フィルタでは、返される指標データに関する特定の特性を指定することによって、カスタム レポートに表示される指標データを制限できます。たとえば、特定の値より長い応答時間の指標データのみ、または特定の名前の API プロキシに関する指標データのみが表示されるように、フィルタを作成できます。

フィルタでは、eqnegtlt などの演算子を使用して複雑なフィルタを作成できる条件構文を使用します。

カスタム レポートの例

最も簡単なカスタム レポートとして、1 つの指標と 1 つ分割項目を指定するカスタム レポートを挙げることができます。たとえば、次の設定でカスタム レポートを定義します。

  • タイプ = 縦棒グラフ
  • 指標 = 1 秒あたりの平均トランザクション数
  • 分割項目 = プロキシ

カスタム レポートには、y 軸に沿って 1 秒あたりの平均トランザクション数の指標が表示される縦棒グラフと、x 軸に沿って API プロキシの分割項目によってグループ化されたデータが含まれます。

カスタム レポートのヒント

複数の指標をカスタム レポートに追加することもできます。たとえば、次の 2 つの指標を指定してカスタム レポートを定義します。

  • タイプ = 縦棒グラフ
  • 指標 = 1 秒あたりの平均トランザクション数
  • 指標 = ポリシーエラー
  • 分割項目 = プロキシ

カスタム レポートでは、指標ごとに個別のグラフが作成され、各指標はグラフの y 軸に表示されます。x 軸はどちらのグラフも同じで、各 API プロキシが縦棒として表示されます。

カスタム レポートの 2 つの指標

複数の分割項目をカスタム レポートに追加することもできます。たとえば、2 つの指標と 2 つの分割項目を含む次の設定でカスタム レポートを定義します。

  • タイプ = 縦棒グラフ
  • 指標 = 1 秒あたりの平均トランザクション数
  • 指標 = ポリシーエラー
  • 分割項目 = プロキシ
  • 分割項目 = デベロッパー ID

グラフには、プロキシ(カスタム レポートを作成したときに指定した最初の分割項目)でグループ化された指標が表示されます。

カスタム レポートの 2 つの分割項目

[Proxy] プルダウン(最初の分割項目に対応)を使用して個別のプロキシを選択できます。更新されたグラフに、デベロッパー ID で選択されたプロキシの指標が表示されるようになります。

カスタム レポートの 2 つの分割項目のドリルダウン

カスタム レポートに分割項目を追加するほど、それぞれの分割項目でレポートをドリルダウンできるように UI も調整されます。

すべてのカスタム レポートの表示

サイド ナビゲーション バーから [Analyze] > [Custom Reports] > [Reports] を選択することによって、カスタム レポートのすべてのリストを表示します。カスタム レポートページには、次の図に示すように、組織用に作成されたすべてのカスタム レポートが表示されます。

カスタム レポート ダッシュボード

図でハイライト表示されているように、カスタム レポートページでは以下を行うことができます。

カスタム レポート ダッシュボードの確認

カスタム レポート ダッシュボードに、特定の時間範囲のカスタム レポートの結果が表示されます。これには、指定した指標の縦棒グラフまたは折れ線グラフも含まれます。

カスタム レポート ダッシュボード

カスタム レポート ダッシュボードでは、以下の操作を行えます。

  • 選択した時間範囲のカスタム レポートデータを表示します。
  • カスタム レポート データを表示する環境を選択します。
  • カスタム レポートデータをフィルタする特定の分割項目を選択します。この領域は、レポートに複数の分割項目を指定した場合のみ有効になります。
  • [Chart] または [Table] ビューを選択します。

  • 関係する指標のテーブル行の [Analyze] を選択して、特定の指標を分析します。異常値を表示して、前の期間や他の指標と比較します。
  • 時間範囲をクリックして設定し、カスタム レポートを実行します。
  • カスタム レポートをダウンロードします。
  • カスタム レポートを編集します。

指標分析ダッシュボードを詳しく見る

サマリー テーブル行の [Analyze] ボタンを選択すると、次のグラフが表示されます(複数の指標を使用するようにレポートを構成した場合、一番上のグラフのみが表示されます)。

指標の分析

これらのグラフには、以下の情報が含まれます。

  • Compare to Metric: 複数の指標を使用するようにレポートを構成した場合、指標を相互に比較します。
  • Compare to Previous Period: 前の期間の指標を表示します。たとえば、過去 24 時間のカスタム レポートを表示するように選択した場合、このグラフには過去 24 時間のデータが表示されます。
  • Analyze Anomalies: レポートデータに外れ値のデータポイントがある場合に、そのデータポイントを表示します。このグラフには、以下の 2 つの値が含まれています。

    • 線として表示される指標の移動平均。線上の特定のポイントについては、移動平均の値が、その時点での指標値、および前の 2 つのデータポイントの指標値の平均として計算されます。
    • グラフの青色の領域は、指標の平均最大値と平均最小値を定義しています。平均最大値は 1.2 *(移動平均)で、平均最小値は 0.8 *(移動平均)です。

    移動平均が平均最大値または平均最小値の範囲外である場合、異常値である可能性があると見なされ、グラフで赤色の点で描画されます。

カスタム レポートの追加

カスタム レポートを追加することで、API プログラムのあらゆる側面についての分析情報を提供する一連のグラフを作成できます。

カスタム レポートを追加した後、同期的または非同期的に実行する必要があります。

カスタム レポートを追加するには:

  1. [Analyze] > [Custom Reports] > [Reports] の順に選択します。
  2. [+ Custom Report] をクリックします。
  3. [Basic] セクションで、以下の情報を入力します。
    項目 説明
    Report Name レポートの名前。
    Report Description レポートの説明。
    Chart Type カスタム アナリティクス データを表示するために使用する、グラフのスタイルを選択します。
    • Column: X 軸は、分割項目によって指定されたグループを表します。
    • Line: X 軸は、時間を表します。
  4. [Metrics] セクションで、以下を行います。
    1. 分析する指標を選択します。
    2. [Sum]、[Average]、[Min]、[Max] の値を表示するための [Aggregate Function] を選択します。
    3. [+ Metric] をクリックして指標を追加します。
  5. [Dimensions] セクションで、[+ Dimension] をクリックし、分割項目([Proxy] など)を選択して、レポートの生成に使用されるデータセットを制限します。分割項目を追加して、データをさらに制限することもできます。
    分割項目
  6. [Filters] セクションで、レポート定義にフィルタを追加して、表示されるデータをさらに絞り込みます。たとえば、weather API プロキシやデベロッパー jane@example.com のデータを除外するフィルタを追加できます。
    1. [+ Filter Condition] をクリックしてフィルタの基準となるエンティティを選択し、[Operator] および [Value] を使用して式を構成して、レポートにデータが包含または除外されるようにします。
    2. チェックマーク アイコン をクリックしてフィルタを保存します。
    3. [+ Filter Condition] をクリックしてさらにフィルタを追加し、[AND] または [OR] コネクタを選択します。
  7. [Save] をクリックします。

レポートは、デフォルトでは過去 1 時間に収集されたデータを使用して実行され、データはカスタム レポート ダッシュボードに表示されます。カスタム レポート ダッシュボードを詳しく見るをご覧ください。

カスタム レポートの実行

Edge Analytics では、レポートを同期的または非同期的に実行できます。

  • 同期レポートの場合、レポート リクエストを実行し、分析サーバーが応答するまでそのリクエストはブロックされます。ただし、レポートで大量のデータ(たとえば、数百 GB)を処理する必要がある場合は、タイムアウトで同期レポートが失敗する可能性があります。

    同期レポートの最大時間範囲は 14 日間です。15 日以上の時間範囲を選択した場合、レポートは常に非同期的に実行されます。

  • 非同期レポートの場合、レポート リクエストを実行し、その後結果を受け取ります。次のように、非同期クエリ処理が適切な代替手段になる場合があります。

    • レポートの分析と作成に時間がかかる場合。
    • グループ化分割項目が多いなどのクエリを複雑にする制約を伴うデータを分析する場合。
    • 一部のユーザーまたは組織のデータ量が大幅に増加したことがわかってからクエリを管理する場合。

    非同期レポートの最大期間は、6 か月間です。

    このドキュメントでは、UI を使用して非同期レポートを開始する方法について説明します。非同期カスタム レポート API の使用で説明されているように、API を使用することもできます。

特定の時間範囲のカスタム レポートを実行するには:

  1. 左側のナビゲーション バーから [Analyze] > [Custom Report] > [Reports] を選択し、[Custom Reports] ページを開きます。
  2. 実行するレポートを選択し、[Custom Report Time Selection] ポップアップを開きます。 期間
  3. [Range] プルダウンで、次のいずれかを選択します。
    • 事前定義された時間範囲([Last Hour] または [Last 7 Days] など)。
    • [Custom Range]。[Custom Range] では、プルダウンで開始日、期間、時間単位(該当する場合)を選択するか、カレンダーを使用して開始日と終了日を選択します。

      [Single Date] を選択すると、カレンダーで選択できる日付が 1 日に制限されます。

  4. レポートを実行するには、[Run Report] プルダウンで次のいずれかを選択します。
    • [Run Report]。レポートを同期的に実行します。結果は、レポートの完了後にカスタム レポート ダッシュボードに表示されます。レポートの実行に 60 秒以上かかる場合は、自動的に非同期レポートに変換されます。

    • [Submit Job]。レポートをバックグラウンド ジョブとして非同期的に実行します。次のダイアログが表示されます。

      非同期送信

      ダイアログの [View Status] をクリックすると、カスタム レポート ジョブのステータスが表示されます。

同期カスタム レポートのダウンロード

同期カスタム レポートを CSV(カンマ区切り値)形式でダウンロードするには:

  • カスタム レポート ダッシュボードの場合:
    • 完全なレポートをダウンロードするには、[Combined CSV] をクリックします。ファイル名は customreportname.csv となります。customreportname はすべて小文字に変換されたカスタム レポート名で、スペースはアンダースコアで置き換えられます。たとえば、proxyerrorstargeterrors.csv です。
    • 特定の分割項目に関連付けられた [CSV] をクリックします。ファイル名は dimension.csv となります。dimension は分割項目名で、スペースはアンダースコアで置き換えられます。たとえば、sum_of_proxy_errors.csv です。

非同期カスタム レポート ジョブの表示

非同期カスタム レポート ジョブを表示するには、次のいずれかを選択します。

  • [Report Submitted as Background Job] ダイアログで [View Status] をクリックします。
  • 左側のナビゲーション バーで [Analyze] > [Custom Reports] > [Report Jobs] を選択します。

次の図に示されているように、[Report Jobs] ページが表示されます。

レポートジョブ

[Report Jobs] ページでは、以下を行えます。

  • 過去 7 日間に送信された非同期カスタム レポート ジョブの結果すべてを表示します。

  • カスタム レポート ジョブを表示する環境を選択します。

  • カスタム レポートを表示するには、[Status] が [completed] であることを確認します。その後、レポートに対応する行の上にマウスを移動します。そうすると レポートを表示レポートをダウンロード アイコンが表示されます。レポートを表示 を選択してレポートを表示します。

  • レポートをダウンロード をクリックして、カスタム レポートをダウンロードします。

    レポート全体が、OfflineQueryResult-xxx.zip という名前の ZIP ファイル(CSV ファイルが含まれています)としてダウンロードされます。

  • 検索ボックスに関連する文字列の全部または一部を入力して、カスタム レポートのリストを検索します。表示されているすべての項目で文字列が検索されます。

カスタム レポートの編集

カスタム レポートを編集するには:

  1. すべてのカスタム レポートを表示します。
  2. 編集するレポートの名前をクリックします。
    カスタム レポートが過去 1 時間に収集されたデータに対して実行され、結果が表示されます。
  3. カスタム レポート ダッシュボードの [Edit] をクリックします。
  4. カスタム レポートの詳細を編集します。
  5. [Save] をクリックします。
カスタム レポートの結果に戻ります。

カスタム レポートの削除

カスタム レポートを削除するには:

  1. すべてのカスタム レポートを表示します。
  2. 削除するカスタム レポートの [Actions] 列で [Delete] をクリックします。
  3. [Delete] をクリックして削除操作を確認します。

カスタム レポートのカスタムの役割の管理

カスタム レポートページから、カスタム レポートの [Actions] 列の [Roles] をクリックして、カスタム レポートに対して定義されているカスタムの役割を表示および編集できます。

カスタムの役割の設定を編集するには、[Edit] をクリックします。

ユーザーへのカスタムの役割の割り当てについて詳しくは、役割の割り当てをご覧ください。