GraphQL-Überwachungsdashboard und Protokollierung (Vorschau)

Nach der Bereitstellung einer API für GraphQL in Fabric sollten Sie verstehen, wie die API von Clients verwendet wird, und Fehler beheben, falls probleme mit der API auftreten. Verwenden Sie das Fabric GraphQL-Überwachungsdashboard, um Ihre GraphQL-API-Anforderungsaktivität zu visualisieren, zu überwachen und zu beheben. Dieses Feature befindet sich derzeit in der Vorschau. In diesem Artikel wird erläutert, wie Sie die Überwachung aktivieren und die Komponenten des Dashboards effektiv verwenden.

Voraussetzungen

• Aktivierte Arbeitsbereichsüberwachung. Weitere Informationen finden Sie unter Übersicht über die Arbeitsbereichsüberwachung. Führen Sie dazu die Schritte aus, um die Arbeitsbereichsüberwachung zu aktivieren.
• Bevor Sie mit der Verwendung der Überwachungs- und Protokollierungsfunktionen beginnen, müssen Sie über eine API für GraphQL in Fabric verfügen. Weitere Informationen finden Sie unter Erstellen einer API für GraphQL in Fabric und Hinzufügen von Daten.

Aktivieren der GraphQL-API-Überwachung

In diesem Abschnitt werden Sie durch die Schritte geführt, die zum Aktivieren der Überwachung für Ihre API für GraphQL erforderlich sind. Dieses Feature ist standardmäßig deaktiviert.

1. Um Metriken und/oder die Protokollierungsumgebung für jede API für GraphQL in Ihrem Mandanten zu aktivieren, öffnen Sie Ihre GraphQL-API, und wählen Sie dann das Einstellungssymbol aus:

   

2. Wählen Sie im Fenster mit den API-Einstellungen die Option Überwachung (Vorschau) im linken Menü aus. Wenn Arbeitsbereichsüberwachung noch nicht aktiviert wurde, wird eine Notiz angezeigt, die Sie auffordert, zu den Arbeitsbereichseinstellungen zu wechseln, um sie zu aktivieren.

   

3. Nachdem Sie die Überwachung für den Arbeitsbereich aktiviert haben, werden die Optionen zum alleinigen Aktivieren von Metriken (API-Dashboard), der Protokollierung (API-Anforderungen) oder beiden angezeigt. Die Metriken und Protokolle werden in separaten Tabellen in Kusto gespeichert, und Sie können jedes Feature je nach Anforderung separat aktivieren. Standardmäßig sind beide Optionen deaktiviert:

   

API-Anforderungsaktivität

Sobald die Überwachung aktiviert ist, wird die Option API-Anforderungsaktivität im oberen Menüband der GraphQL-API aktiviert. Wählen Sie sie aus, um auf Überwachungsdetails zuzugreifen.

Die API-Anforderungsaktivität besteht aus zwei primären Ansichten:

1. API-Dashboard (für Metriken): Auf dieser Seite werden alle Leistungsindikatoren und Diagramme für den angegebenen Zeitraum angezeigt.
2. API-Anforderungen (für die Protokollierung): Auf dieser Seite werden API-Anforderungen innerhalb des angegebenen Zeitraums aufgelistet.

In den folgenden Abschnitten beschreiben wir die Funktionalität jeder Option.

Metriken (API-Dashboard)

Das API-Dashboard bietet eine Übersicht über API-Aktivitäten für Sie mit verschiedenen Metriken und visuellen Elementen. Um darauf zuzugreifen, wählen Sie auf der Seite API-Anforderungsaktivität die Registerkarte API-Dashboard aus. Sie können jetzt auf einen Blick die folgenden Parameter für einen bestimmten Zeitraum anzeigen:

• Allgemeiner GraphQL-API-Gesundheitsindex, der Folgendes umfasst:

  • API-Anforderung/Sek.
  • Erfolgsquote
  • Gesundheitszustand

• Anzahl der API-Anforderungen

• Latenz

• Anzahl der Anforderungen im Balkendiagramm, das die Anzahl der Erfolge und Fehler veranschaulicht

Wenn Sie mit dem Mauszeiger über das Diagramm fahren, können Sie die detaillierten Informationen für einen bestimmten Datenpunkt in einem Tooltipp anzeigen.

Wichtige Features der Metriken:

• Zeitbereichsauswahl: Sie können verschiedene Zeitbereiche für die daten auswählen, die in den Überwachungsdiagrammen angezeigt werden. Beachten Sie, dass die Datenaufbewahrung aufgrund von Beschränkungen der Arbeitsbereichsüberwachung nur für 30 Tage verfügbar ist.

  

• API-Anforderung/Sek.: Sie können die Anzahl der API-Anforderungen anzeigen, die jede Sekunde im ausgewählten Zeitraum getätigt wurden.

  

• Erfolgsquote: Sie können die Erfolgsquote anzeigen, die die Anzahl der erfolgreichen Anfragen im Verhältnis zur Gesamtanzahl der Anfragen im ausgewählten Zeitraum zeigt.

  

• Gesamtzustandindex der GraphQL-API basierend auf der Erfolgsrate pro API:

  • Grün: 75–100 % von erfolgreichen Anforderungen sind (fehlerfrei)

  • Gelb: 50 - 74% der Anfragen sind erfolgreich (Benötigt Aufmerksamkeit)

  • Rot: Weniger als 50 % erfolgreiche Anforderungen (fehlerhaft)

    

• Gesamtanzahl der API-Anforderungen: Sie können die Gesamtanzahl der API-Anforderungen im ausgewählten Zeitraum anzeigen.

• Latenz Liniendiagramm: Wenn Sie mit dem Mauszeiger auf Diagramme zeigen, können Sie die Latenz und das Datum für jeden Datenpunkt sehen.

  

• Anzahl der Anforderungen Balkendiagramm, unterscheidung zwischen Erfolgsanforderungen und Fehlern: Wenn Sie auf Diagramme zeigen, können Sie das Datum und die Anzahl der Erfolge und Fehler für jeden Datenpunkt anzeigen.

  

Wenn sie ein ungewöhnliches Verhalten auf dem Dashboard sehen, das Ihre Aufmerksamkeit erfordert, können Sie weiter untersuchen, indem Sie protokolle untersuchen, um potenzielle Probleme zu identifizieren und herauszufinden, welche Anforderungen fehlgeschlagen sind und eine höhere Latenz haben und beginnen, Protokolldetails zur Problembehandlung zu untersuchen. Um auf Protokollierungsdetails zuzugreifen, wählen Sie die Registerkarte API-Anforderungen auf der Seite API-Anforderungsaktivität aus.

Protokollierung (API-Anforderungen)

Die Seite "API-Anforderungen" enthält detaillierte Informationen zu allen API-Anforderungen, die in einem bestimmten Zeitrahmen aufgetreten sind. Um darauf zuzugreifen, wählen Sie die Registerkarte API-Anforderungen auf der Seite API-Anforderungsaktivität aus.

Protokollierung der wichtigsten Features:

• Auswahl des Zeitraums: Sie können verschiedene Zeitbereiche für die Daten auswählen, die in der Anforderungsliste angezeigt werden (Stunde/Tag/Woche/Monat). Beachten Sie, dass es Aufbewahrungsgrenzwert von 30 Tagen gibt.

• Zeigen Sie eine Liste der zuletzt verwendeten API-Anforderungen und früheren Anforderungen an, die mit der Anforderungs-ID aufgelistet sind.
• Zeigen Sie den Typ des Vorgangs an (Abfrage oder Mutation).
• Anzeigen des transportprotokolls, das von der Anforderung (HTTP) verwendet wird.
• Zeigen Sie die Uhrzeit der Anforderung an.
• Sortieren Sie die Liste der Anforderungen nach aufsteigender/absteigender Zeit.
• Dauer der Anforderung anzeigen
• Sortieren Sie die Liste der Anforderungen nach aufsteigender/absteigender Dauer.
• Antwortgröße anzeigen.
• Anzeigen des Status (Erfolg oder Fehler).
• Zeigen Sie die Details der Anforderung an, einschließlich spezifischer Antwort-/Warnmeldungen/Fehlermeldungen.
• Filtern und suchen Sie nach bestimmten Zeichenfolgen oder Sätzen.
• Ändern Sie die Größe von Spalten, und sortieren Sie die Spalten (aufsteigend/absteigend) aus der Berichtstabelle.

Verwandte Inhalte

• Microsoft Fabric-API für GraphQL
• Ankündigung zur Arbeitsbereichüberwachung
• Übersicht über die Arbeitsbereichsüberwachung
• API für GraphQL in Fabric
• Fabric-API für GraphQL-Editor
• Fabric-API für GraphQL: Schema-Ansicht und Explorer