+
+

ラボ 3: APIのモニタリング(分析)

概要

API Gatewayへの導入が完了すると、分析データをAnypoint Platform API Analyticsに送信し始めます。これにより、トップユーザー、地域別のトランザクション、階層別の使用状況、SLAに対するパフォーマンスなどの主要なメトリクスをインタラクティブでグラフィカルなダッシュボードやチャートのセットで追跡することができます。数回のクリックでカスタム・ダッシュボードを作成でき、APIプラットフォームのAPIを介してメトリクスを抽出する機能も提供します。

module 5 lab3 overview

ステップ 1:APIアナリティクスの表示

API analytics では、トップユーザー、地域別のトランザクション、階層別の使用状況、SLAに対するパフォーマンスなどの主要なメトリクスをインタラクティブでグラフィカルなダッシュボードやチャートのセットで追跡することができます。

API analytics は、API Manager で確認できます。

各APIのAPI設定ページでは、リクエスト数、トップアプリ数、レイテンシーなどのアナリティクスデータのいくつかのサマリーを見ることができます。

  1. 組織の管理者 として、組織の Analytics Dashboards にアクセスできます。API Manager に移動して、Analytics をクリックして、Overview に移動します。

    module 5 lab3 ap analytics dashboard
    データが何も表示されない場合は、正しい環境が選択されているか (Sandbox) を確認し、 Date Range を1時間に変更してみてください。

    組織のアナリティクスにアクセスすると、デフォルトではオーバービューダッシュボードが表示されます。このダッシュボードには、4つの標準チャートが表示されます:

    • Requests by Date: 組織内のすべてのAPIに対するリクエスト数を示す折れ線グラフ。

    • Requests by Location: 国ごとのリクエスト数を示すマップチャート。

    • Requests by Application: アプリケーション別のリクエスト数を示す棒グラフ。登録されているアプリケーションの上位 5 つのアプリケーションごとのリクエスト数を示す棒グラフ。

    • Requests by Platform: プラットフォーム別のリクエスト数を示すリングチャート。

  2. Interactive Dashboard: 時間範囲をクリックしてマウスをドラッグしてカスタムの時間範囲を作成することで、ダッシュボードを操作できます。オーバービューダッシュボードのグラフは相互にリンクされているので、カスタム時間範囲を設定することで、下部のグラフに表示されるリクエストの数や種類を変更することができます。例えば、カナダのように特定の国を選択して、その特定の場所からのリクエストのみを表示することができます。

グラフが表示されない場合は、正しい環境にいることを確認してください。SANDBOX にいる必要があります。

ステップ 2:カスタムダッシュボードの作成

オーバービューダッシュボードでは、APIの使用状況を集約して見ることができますが、通常は、より詳細なAPI使用状況を見る必要があります。Anypoint Analyticsプラットフォームでは、より詳細な情報を表示するために、ユーザーがチャートを作成したり、カスタムダッシュボードを構築したりすることができます。このステップでは、レスポンスタイム、レスポンスコード、都市別リクエスト、ポリシー違反の表示など、4つのカスタムチャートを構築してカスタムダッシュボードを作成します。

module 5 lab3 ap analytics create custom

カスタムダッシュボードを作成するには:

  1. メニューの Custom Dashboard をクリックします。

  2. Create Chart を選択します (注意 - 左側に Create Chart が表示されない場合は、Edit Dashboard をクリックしてください)

    module 5 lab3 ap analytics custom dashboad create chart
  3. チャートの Title を追加します。

  4. Mythical Omni Channel API GatewayResponse Time をチャート化するメトリクスと、その値の集計方法を以下のように指定します。データ間隔は必ず Minutes に変更してください。

    module 5 lab3 ap analytics edit chart resp time
  5. 完了したら、Save Chart を選択します。

  6. 以下のように、すべてのAPI のレスポンスステータスコードを追跡するためのチャートを作成します。

    module 5 lab3 ap analytics edit chart request status
    右側を下にスクロールして、デフォルトの折れ線グラフではなく円グラフを選択してください。そうしないと、Group By オプションが表示されません。
  7. Save Chart をクリックします。

  8. 国や都市ごとにリクエストをグループ化した表を作成します。

    module 5 lab3 ap analytics edit chart reqs country
  9. Save Chart をクリックします。

  10. 最後に作成するチャートは、ポリシー違反のあるリクエストを測定するためのものです。

    module 5 lab3 ap analytics edit chart policy violation
  11. Save Chart をクリックします。

    チャートが保存されると、カスタムダッシュボードのキャンバスに追加できるようになります。

  12. 新しく作成したチャートをダッシュボードのキャンバスにドラッグ&ドロップします。

    module 5 lab3 ap analytics custom dashboard empty
    module 5 lab3 ap analytics custom dashboard complete
    ドラッグドロップオプションがブラウザーで機能しない場合は、左側のペインの各グラフの横にある緑色の「+」をクリックすると、キャンバスに追加されます。
  13. ダッシュボードエディターの右上にある Save Dashboard をクリックします。

これで、APIに特化するメトリクスを表示するダッシュボードができました。

module 5 lab3 ap analytics custom dashboard finished

まとめ

  • APIアナリティクスの表示

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

このラボでは、内蔵のAPIアナリティクスとカスタムダッシュボードを使用してAPIを監視することを確認しました。APIの 可視性 が提供されることにより、APIがどのように消費され、利用されているかを理解することができます。

module 5 lab3 overview

カスタムダッシュボードとカスタムチャート集計の作成についての詳細は、Muleドキュメントの API Analytics ダッシュボードで確認できます。

おめでとうございます!ラボ3が完了しました。

次のラボ(オプション)では、オートディスカバリを使ってMuleアプリケーションを管理する方法を説明します。

希望する場合は、ラボ 4に進んでください。

そうでない場合は…​

おめでとうございます!モジュール5が完了しました。

モジュール 6 に進んでください。

Submit your feedback!
Share your thoughts to help us build the best workshop experience for you!
Take our latest survey!