1. Homepage
  2. API Manager (2.x)
  3. Mule API Analytics の表示

  4. Mule API Analytics の使用方法の確認

Mule API Analytics の使用方法の確認

API Manager と Anypoint Monitoring の両方から Mule API Analytics データを表示できます。API Manager は Mule API Analytics データを最大 30 日間保持します。ただし、Anypoint Monitoring は 30 日の保持期間でさらに堅牢な API 使用状況データを提供します。

API Manager で Mule API Analytics データを表示する手順は、次のとおりです。

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [Mule API Analytics]​ をクリックします。

ダッシュボードから、Anypoint Platform で収集された API に関する分析に移動できます。

Anypoint Monitoring でデータを表示する方法についての詳細は、​「Anypoint Monitoring API Analytics ダッシュボード」​を参照してください。

Mule API の分析にアクセスすると、デフォルトで、次のチャートを表示する概要ダッシュボードが表示されます。

  • Requests by Date (日付別要求数)​: 組織内のすべての API の要求数を示す折れ線チャート。

  • Requests by Location (場所別要求数)​: 発信元の国別に要求数を示すマップチャート。

  • Requests by Application (アプリケーション別要求数)​: 上位 5 つの登録済みアプリケーション別に要求数を示す棒チャート。

  • Requests by Platform (プラットフォーム別要求数)​: プラットフォーム別に分類された要求数を示すドーナツチャート。

「API Manager Analytics」 ダッシュボード。

デフォルトでは、組織内の API に関する過去 1 日のデータがこれらのチャートに表示されます。ページの左上にある検索条件を使用して、日付範囲を変更したり、特定の API に絞り込んだりすることができます。時間範囲にはローカルタイムゾーンが反映されています。

選択可能な日付範囲オプションが表示された 「Date Range (日付範囲)」 検索条件ドロップダウンメニュー。

カスタム期間を選択すると、日別要求数の折れ線チャートの要求数は正規化されません。たとえば、月次チャートには、4 時間あたりの要求数が表示されます。2 か月間の場合、同じチャートには 8 時間あたりの要求数が表示されます。カスタムダッシュボードで折れ線チャートを使用していて、カスタム期間を定義する必要がある場合は、集約期間を明示的に設定する必要があります。

概要ダッシュボードのすべてのチャートにはクロス条件で絞り込まれます。いずれかのチャートのデータを絞り込む場合、同じ検索条件がページ上の他のチャートに適用されます。たとえば、棒チャートで個々のアプリケーションをクリックすると、そのアプリケーションからのすべての要求が表示され、それらの要求の場所がマップに表示されます。各チャートのデータを絞り込む方法は、次のとおりです。

チャート データの絞り込み方法 検索条件のクリア方法

Requests by Date (日付別要求数)

チャートの領域をクリックしてドラッグし、その期間のみに絞り込みます。スライダー検索条件を適用したら、必要に応じて端をドラッグして調整できます。

絞り込まれた部分の領域の外側をクリックします。

Requests by Location (場所別要求数)

1 つ以上の国をクリックし、それらの結果のみに絞り込みます。国にカーソルを置くと、国名と、選択した期間中にその国から受信した API 要求の総数を表示するツールヒントが表示されます。

国を再度クリックするとマップがリセットされます。

Requests by Application (アプリケーション別要求数)

1 つ以上のアプリケーションの棒をクリックし、それらの結果のみに絞り込みます。アプリケーションのデータの棒にカーソルを置くと、アプリケーション名と、その期間中にそのアプリケーションから受信した合計要求数を表示するツールヒントが表示されます。

アプリケーションを再度クリックするとチャートがリセットされます。

Requests by Platform (プラットフォーム別要求数)

1 つ以上のセグメントをクリックし、それらの結果のみに絞り込みます。セグメントにカーソルを置くと、アプリケーション名と、その期間中にそのアプリケーションから受信した合計要求数を表示するツールヒントが表示されます。

セグメントを再度クリックするとチャートがリセットされます。

いずれかのチャートのデータをエクスポートするには、[Export (エクスポート)] アイコン (​曲がった矢印​) をクリックします。

いずれかのチャートのデータを絞り込みんで選択したデータのみを表示している場合、エクスポートアイコンをクリックすると、ページ左上の検索条件を使用して選択した日付範囲と API でそのチャートの完全データを絞り込んだ .csv ファイルのエクスポートがトリガーされます。エクスポートされるファイルは、最大 100 万レコードに制限されます。

ダッシュボードにポリシー違反を含める

注意:​ ポリシーを参照したり、ポリシー違反アラートを編集したりするには、ユーザーに​「ポリシーの参照」​権限セットが必要です。 詳細は、​「権限の設定」​を参照してください。

ダッシュボードの [Include Policy Violations (ポリシー違反を含める)] チェックボックスを使用して、ポリシー違反の追跡を有効または無効にします。ダッシュボードには、ポリシーによって拒否された、または拒否されなかったトラフィックが表示されます。

「Include Policy Violations (ポリシー違反を含める)」 チェックボックスがオンの API Manager ポリシー違反チャート。

カスタムチャートの作成

さまざまなカスタムチャートを作成して、カスタムダッシュボードに特定のデータを表示できます。

たとえば、次を表示するカスタムチャートを作成できます。

  • その月の 1 日から今日までの毎時間の 1 秒あたりのトランザクション数をクライアント ID、API バージョン、または SLA 層で絞り込む。

  • 過去 24 時間の 1 分あたりのレイテンシー平均を API で絞り込む、またはクライアントの地理位置情報でグループ化する。

  • サブスクライブしているアプリケーションごと、違反ポリシー名ごとにグループ化されたポリシー違反数。

    ポリシー違反をトリガーしたイベントが含まれるのは、違反ポリシー名でグループ化するチャートのみです。その他のチャートからはこれらのイベントが除外されます。たとえば、API が 100 個の要求を受信し、90 個が成功し、10 個がレート制限ポリシーによって拒否されるとします。違反ポリシー名でグループ化しないチャートでは、制限されなかった 90 個の要求のみに基づいて集約が計算されます。ただし、違反ポリシー名でグループ化するチャートでは、100 個すべての要求が計算に含まれます。

カスタムチャートを作成するには、[Manage Charts (チャートを管理)] をクリックします。

  1. [API Manager]​ > ​[Mule API Analytics]​ > ​[Manage Charts (チャートを管理)]​ に移動し、​[New (新規)]​ をクリックします。

    [Create Chart (チャートの作成)] が表示されます。

    「Create Chart (チャートの作成)」 ページ。

  2. [Title (タイトル)]​ と ​[Description (説明)]​ (省略可能) を入力します。

  3. チャートの種類のグラフィックをクリックします。

    アイコン チャートの種類 チャートのオプション

    折れ線チャートのサムネイル画像。

    折れ線チャート

    Data Source (データソース)、Metric (メトリクス): メトリクス​、Total (合計)、Data Interval (データ間隔): 期間

    棒チャートのサムネイル画像。

    棒チャート

    Data Source (データソース)、Metric (メトリクス): メトリクス​、Total (合計)、Group By (グループ化条件): カテゴリ

    積み上げチャートのサムネイル画像。

    積み上げチャート

    Data Source (データソース)、Metric (メトリクス): メトリクス​、Total (合計)、Group By (グループ化基準): カテゴリ​、Then By (第 2 基準): カテゴリ

    ドーナツチャートのサムネイル画像。

    ドーナツチャート

    Data Source (データソース)、Metric (メトリクス): メトリクス​、Total (合計)、Group By (グループ化条件): カテゴリ

    マップチャートのサムネイル画像。

    マップチャート

    Data Source (データソース)、Metric (メトリクス): メトリクス​、Total (合計)

  4. [Data Source (データソース)] の値を選択します。

    • 組織内のすべての API

    • 特定の API

  5. [Metrics (メトリクス)] の値 (​メトリクス​) と [Total (合計)] を選択します。

    • Request Size (要求サイズ) (バイト)

    • Requests (要求)

    • Response Size (応答サイズ) (バイト)

    • Response Time (応答時間) (ミリ秒)

  6. 折れ線チャートの場合は、[Data Interval (データ間隔)] の値 (​期間​) を選択します。

    • Minutes (分)

    • Hours (時間)

    • Days (日)

  7. 棒チャートと積み上げチャートの場合は、[Group By (グループ化基準)] のカテゴリと、チャートでサポートされている場合は [Then By (第 2 基準)] のカテゴリを選択します。

    • API Name (API 参照名)

    • API バージョン

    • Application (アプリケーション)

    • Browser (ブラウザー)

    • City (市区郡)

    • Client IP (クライアント IP)

    • Continent (大陸)

    • Country (国)

    • Hardware Platform (ハードウェアプラットフォーム)

    • OS Family (OS ファミリー)

    • OS Major Version (OS メジャーバージョン)

    • OS Minor Version (OS マイナーバージョン)

    • OS Version (OS バージョン)

    • Postal Code (郵便番号)

    • Resource Path (リソースパス)

    • Status Code (状況コード)

    • Timezone (タイムゾーン)

    • User Agent Type (ユーザーエージェント種別)

    • User Agent Version (ユーザーエージェントバージョン)

    • Verb (動詞)

    • Violated Policy Name (違反ポリシー名)

      積み上げチャートの場合は、2 つのディメンションでデータをグループ化できます。最初のディメンションで個別の列を定義し、2 つ目のディメンションでこれらの列内の積み上げを定義します。2 つ目のグループ化ディメンションでも 1 つ目と同じオプションを使用できます。

  8. チャートを保存します。

    カスタムチャートが表示されます。

カスタムチャートの例: アプリケーションごとのポリシー違反

  1. [API Manager]​ > ​[Mule API Analytics]​ > ​[Manage Charts (チャートを管理)]​ に移動し、​[New (新規)]​ をクリックします。

  2. [Title (タイトル)] に「​Policy Violations Per Application​」 (アプリケーションごとのポリシー違反) と入力します。

  3. [Description (説明)] に​「Number of violations per subscribed application」​ (サブスクライブしているアプリケーションごとの違反数) と入力します。

  4. 積み上げチャートを選択します。

  5. [Data Source (データソース)] と [Metric (メトリクス)] で、デフォルト値をそのまま使用します。

  6. 積み上げチャートの 2 つのグループ化レベルを選択します。

    • [Application (アプリケーション)] を選択し、アプリケーションごとに縦棒を表示します。

    • [Violated Policy Name (違反ポリシー名)] を各縦棒内の積み上げとして選択します。

      「Group By (グループ化基準)」 と 「Then By (第 2 基準)」 の 「Violated Policy Name (違反ポリシー名)」 によって絞り込まれたアプリケーションが表示されている [Create Chart (チャートの作成)] ページの下部。

  7. チャートを保存します。

    チャートが表示されます。

    アプリケーション別のポリシー違反が表示されたチャート。

カスタムダッシュボードの作成

カスタムチャートを作成した後に、独自のカスタムダッシュボードにそれらのチャートを並べて表示できます。

カスタムダッシュボードにアクセスするには、[Custom Dashboard (カスタムダッシュボード)] をクリックします。初めて開いたとき、カスタムダッシュボードは空白になっています。

  1. [API Manager]​ > ​[Mule API Analytics]​ > ​[Custom Dashboard (カスタムダッシュボード)]​ に移動し、​[Edit Dashboard (ダッシュボードを編集)]​ をクリックします。

  2. カスタムチャートを作成したことを前提とし、画面左側のドロワーからダッシュボードにチャートをドラッグアンドドロップして、必要に応じて順序を並べ替えます。

  3. ダッシュボードにチャートを追加したら、開いて編集するか、[X] をクリックしてダッシュボードから削除することができます。

  4. 完成したら、カスタムダッシュボードを保存します。

    カスタムダッシュボードが表示されます。

いくつかのカスタムチャートが表示されたカスタムダッシュボード。

日付範囲ピッカーを使用して、ダッシュボードのすべてのチャートの期間を調整します。

分析データのエクスポート

概要ダッシュボードまたはカスタムダッシュボードに表示されたチャートから分析データをエクスポートすることができます。どちらかのダッシュボードで、[Export (エクスポート)] アイコン (​曲がった矢印​) をクリックして、そのチャートのデータを含む CSV ファイルをダウンロードします。

ダウンロードするデータには、選択した絞り込みオプションが反映されています。ただし、概要ダッシュボードからチャートデータをエクスポートし、チャートのサブセクションを 1 つ以上選択した場合、エクスポートされるファイルに絞り込みオプションは含まれません。エクスポートされるファイルには、そのチャートの完全データが含まれます。

関連情報