GraphQL の監視ダッシュボードとログ記録 (プレビュー)

Fabric で GraphQL 用 API をデプロイした後、API がクライアントによってどのように使用されているかを理解し、API に問題がある場合のエラーのトラブルシューティングを行うことができます。 Fabric GraphQL 監視ダッシュボードを使用して、GraphQL API 要求アクティビティを視覚化、監視、トラブルシューティングします。 この機能は現在プレビュー段階です。 この記事では、監視を有効にして、ダッシュボードのコンポーネントを効果的に使用する方法について説明します。

前提 条件

• ワークスペース の監視を有効にしました。 詳細については、「ワークスペース監視の概要 」を参照し、ワークスペース監視 を有効手順に従ってください。
• 監視とログ記録の機能の使用を開始する前に、Fabric の GraphQL 用 API が必要です。 詳細については、「Fabric で GraphQL 用 API を作成し、データを追加する」を参照してください。

GraphQL API の監視の有効化

このセクションでは、GraphQL 用 API の監視を有効にするために必要な手順について説明します。 既定では、この機能はオフになっています。

1. テナント内の GraphQL の各 API に対してメトリックやログ記録エクスペリエンスを有効にするには、GraphQL API を開き、[設定] アイコンを選択します。

   

2. [API 設定] ウィンドウで、左側のメニューから 監視 (プレビュー) オプションを選択します。 ワークスペースの監視 がまだ有効になっていない場合は、ワークスペース設定に移動して有効にする を案内するメモが表示されます。

   

3. ワークスペースの監視を有効にすると、メトリック のみ (API ダッシュボード)、ログ記録 のみ (API 要求)、またはその両方を有効にするオプションが表示されます。 メトリックとログは Kusto の個別のテーブルに保存され、要件に応じて各機能を個別に有効にすることができます。 既定では、両方のオプションがオフになっています。

   

API 要求アクティビティ

監視が有効になると、GraphQL API の上部リボンの API 要求アクティビティ オプションがアクティブになります。 監視の詳細にアクセスするには、それを選択します。

API 要求アクティビティ は、次の 2 つの主要ビューで構成されます。

1. API ダッシュボード (メトリックの場合): このページには、指定した時間範囲のすべてのカウンターとグラフが表示されます。
2. API 要求 (ログ記録用): このページには、指定した時間範囲内の API 要求が一覧表示されます。

以降のセクションでは、各オプションの機能について説明します。

メトリック (API ダッシュボード)

API ダッシュボードには、さまざまなメトリックとビジュアルを含む API アクティビティの概要が表示されます。 アクセスするには、API 要求アクティビティ ページで、API ダッシュボード タブ 選択します。これで、特定の時間範囲の次のパラメーターをひとめで確認できるようになりました。

• 以下を含む GraphQL API Health の全体的なインデックス:

  • API リクエスト/秒
  • 成功率
  • 健康状態

• API 要求の数

• レイテンシ

• 成功とエラーの数を示す横棒グラフ内の要求の数

グラフにカーソルを合わせると、ヒントに特定のデータ ポイントの詳細情報が表示されます。

メトリックの主な機能:

• 時間範囲の選択: 監視グラフに表示されるデータに対して異なる時間範囲を選択できます。 ワークスペースの監視制限のため、データの保持期間は 30 日間のみを使用できることに注意してください。

  

• API Request/sec: 選択した時間範囲内で 1 秒ごとに行われた API 要求の数を表示できます。

  

• 成功率: 選択した時間範囲の要求の合計数に対する成功した要求の数である成功率を表示できます。

  

• API ごとの成功率に基づく GraphQL API 正常性の全体的なインデックス:

  • 緑: 75 から 100% の要求が成功 (正常)

  • 黄: 50 から 74% の要求が成功 (要注意)

  • 赤: 成功した要求は 50% 未満 (異常)

    

• API 要求の合計数: 選択した時間範囲内の API 要求の合計数を表示できます。

• 待機時間 折れ線グラフ: グラフの上にマウス ポインターを置くと、各データ ポイントの待機時間と日付を確認できます。

  

• 成功要求とエラーの区別 横棒グラフの要求数: グラフにカーソルを合わせると、各データ ポイントの成功とエラーの日付と数を確認できます。

  

注意が必要な異常な動作がダッシュボードに表示された場合は、ログを調べて潜在的な問題を特定し、失敗した要求と待機時間の長い要求を特定し、トラブルシューティングを行うためにログの詳細の調査を開始することで、さらに調査できます。 ログの詳細にアクセスするには、API 要求アクティビティ ページから API 要求 タブを選択します。

ログ記録 (API 要求)

[API 要求] ページには、特定の期間に発生したすべての API 要求に関する詳細情報が表示されます。 アクセスするには、API 要求アクティビティ ページから API 要求 タブを選択します。

ログ記録の主な機能:

• 時間範囲の選択: 要求の一覧に表示されるデータに対して、異なる時間範囲を選択できます (時間/日/週/月)。 30 日間のリテンション期間の制限があることに注意してください。

• 最近の API 要求と過去の要求の一覧を要求 ID と共に表示します。
• 操作の種類 (クエリまたは変更) を表示します。
• 要求 (HTTP) によって使用されるトランスポート プロトコルを表示します。
• 要求の時刻を表示します。
• 要求の一覧を昇順または降順で並べ替えます。
• 要求の期間を表示します。
• 要求リストを所要時間の昇順または降順で並べ替えます。
• 応答サイズを表示します。
• 状態 (成功または失敗) を表示します。
• 特定の応答/警告/エラー メッセージなど、要求の詳細を表示します。
• 特定の文字列または文をフィルター処理して検索します。
• 列のサイズを変更し、レポート テーブルの列を昇順または降順で並べ替えます。

関連コンテンツ

• GraphQL 用の Microsoft Fabric API
• ワークスペース監視のお知らせ
• ワークスペース監視の概要
• Fabric における GraphQL のための API
• GraphQL エディター用の Fabric API
• GraphQL スキーマ ビューとエクスプローラー用の Fabric API