Bewährte Methoden zur Unterstützung

Dieses Lernprogramm enthält Anleitungen für Fabric Extensibility Toolkit-Entwickler, wie sie ihre Kunden unterstützen können. Es behandelt bewährte Methoden zum Verwalten, Speichern und Korrelieren wichtiger Anforderungsheader sowie Empfehlungen für Protokollierung, Überwachung und Support.

Überblick

Mit dem Fabric Extensibility Toolkit können Entwickler Workloads erstellen, die nahtlos in die Microsoft Fabric-Plattform integriert werden. In diesem Dokument werden die Unterstützenden Methoden beschrieben, die Entwickler befolgen sollten, um eine effektive Problembehandlung und den Kundensupport sicherzustellen.

Anfrage-Header

Fabric macht zwei wichtige Header in Anforderungen zwischen Kunden und Fabric verfügbar, die für die Unterstützung von entscheidender Bedeutung sind:

  • ActivityId: Eine global eindeutige ID, die von Ihnen, dem Entwickler, verwendet werden kann, um die Anforderung mit Ihren Systemen zu korrelieren, wenn ein Fabric-Benutzer mit Ihrer Workload interagiert.
  • RequestId: Eine global eindeutige ID, die Fabric hilft, Ihre Anforderung mit Plattformablaufverfolgungen zu korrelieren, wodurch Probleme untersucht und Unterstützung bereitgestellt werden. Wenn Sie das Problem auf Ihrer Seite mithilfe der ActivityId nicht ermitteln können, können Sie an den Fabric-Support die RequestId weitergeben, wenn Sie ein Problem melden. Stellen Sie sicher, dass Sie die RequestId Datei beibehalten und speichern, damit sie später problemlos bereitgestellt werden kann.

Bewährte Methoden zur Supportfähigkeit

Um Ihre Kunden effektiv zu unterstützen, ist es wichtig, diese IDs beizubehalten, zu speichern und zu korrelieren. Hier sind einige bewährte Methoden:

1. Protokollierung

  • Aufbewahrung von Protokollen: Stellen Sie sicher, dass Protokolle für einen ausreichenden Zeitraum aufbewahrt werden, um eine effektive Problembehandlung zu ermöglichen.
  • Detaillierte Protokollierung: Fügen Sie die ActivityId und RequestId in alle relevanten Protokolleinträge ein. Auf diese Weise können Sie den Ablauf einer Anforderung über Ihr System nachverfolgen.
  • Integration von Application Insights: Bei von Azure gehosteten Workloads sollten Sie die Integration in Azure Application Insights in Betracht ziehen, um Telemetrie- und Korrelations-IDs automatisch zu erfassen.

2. Überwachung

  • Echtzeitüberwachung: Implementieren Sie die Echtzeitüberwachung, um Probleme bei auftretenden Problemen zu erkennen und zu warnen. Dazu gehören überwachung von Anforderungsraten, Fehlerraten und Systemleistung.
  • Korrelation mit Headern: Stellen Sie sicher, dass Ihre Überwachungstools Protokolle und Metriken mithilfe der ActivityId und RequestId korrelieren können. Auf diese Weise können Sie Probleme schnell erkennen und diagnostizieren.
  • Azure Monitor: Erwägen Sie die Verwendung von Azure Monitor für umfassende Überwachungs- und Warnungsfunktionen.

3. Unterstützung

  • Kundensupport: Schulen Sie Ihr Supportteam darin, bei Kundenproblemen nach ActivityId und RequestId zu fragen. Dadurch wird der Problembehandlungsprozess beschleunigt.
  • Dokumentation: Stellen Sie Ihren Kunden klare Dokumentation zur Verfügung, wie Sie diese IDs beim Melden von Problemen abrufen und verwenden können.
  • Eskalationsprozess: Richten Sie klare Verfahren für die Eskalierung von Problemen an den Fabric-Support ein, wenn eine Untersuchung auf Plattformebene erforderlich ist.

Beispielworkflow

  1. Protokolleintrag: Wenn eine Anforderung empfangen wird, protokollieren Sie die ActivityId und RequestId zusammen mit anderen relevanten Informationen.
  2. Überwachen: Verwenden Sie Überwachungstools, um die Anforderung in Echtzeit nachzuverfolgen und mit den IDs zu korrelieren.
  3. Problembehandlung: Wenn ein Problem auftritt, verwenden Sie die ActivityId und RequestId, um die Anforderung über Ihre Protokolle und Systeme nachzuverfolgen.
  4. Support: Wenn ein Kunde ein Problem meldet, fragen Sie nach ActivityId und RequestId, um die relevanten Protokolle schnell zu finden und Unterstützung bereitzustellen. Wenn das Problem auf Ihrer Seite nicht festgestellt werden kann, stellen Sie den RequestId dem Support von Fabric für weitere Untersuchungen bereit.

Überlegungen zur Implementierung

Für Frontend-exklusive Workloads

  • Extrahieren von Korrelationsheadern aus dem Workload-Clientkontext, wenn verfügbar
  • Korrelations-IDs an alle externen API-Aufrufe übergeben, die Ihre Workload macht.
  • Korrelations-IDs in Browserkonsolenprotokolle zum Debuggen einschließen

Für Workloads mit Back-End-Komponenten

  • Verteilen von Korrelationsheadern über Ihre Dienstarchitektur
  • Implementieren der strukturierten Protokollierung, die Korrelations-IDs enthält
  • Einrichten von Überwachungsdashboards, die nach Korrelations-IDs filtern können

Azure-Integration

  • Application Insights: Erfasst automatisch die Anforderungskorrelation und stellt integrierte Dashboards bereit.
  • Azure Log Analytics: Abfrageprotokolle mithilfe von Korrelations-IDs zur Problembehandlung
  • Azure-Warnungen: Einrichten von Warnungen basierend auf Fehlermustern oder Leistungsmetriken

Richtlinien für den Kundensupport

Für Ihre Kunden

Stellen Sie Kunden klare Anweisungen zum Melden von Problemen bereit:

  1. Aktivitäts-ID: Kann häufig in Konsolenprotokollen der Browserentwicklertools gefunden werden
  2. Anforderungs-ID: Kann in Fehlermeldungen angezeigt oder über Supporttools verfügbar sein
  3. Zeitstempel: Zeitpunkt des Problems
  4. Kontext: Welcher Vorgang ausgeführt wurde, wenn das Problem aufgetreten ist

Für Ihr Supportteam

Schulen Sie Ihr Supportteam für Folgendes:

  1. Korrelations-IDs sammeln: Fragen Sie immer nach ActivityId und RequestId bei der Untersuchung von Problemen.
  2. Verwenden von Diagnosetools: Nutzen Ihrer Protokollierungs- und Überwachungssysteme zum Nachverfolgen von Problemen
  3. Eskalieren bei Bedarf: Wissen Sie, wann Sie an den Fabric-Support eskalieren müssen RequestId
  4. Dokumentlösungen: Erstellen einer Wissensbasis mit häufig auftretenden Problemen und deren Korrelationsmustern

Conclusion

Mithilfe dieser bewährten Methoden können Entwickler ihre Kunden auf der Fabric-Plattform effektiv unterstützen und einen nahtlosen und effizienten Problembehandlungsprozess sicherstellen. Die ordnungsgemäße Protokollierung, Überwachung, Anforderungsverwaltung und Supportprotokolle sind unerlässlich, um hohe Servicequalität und Kundenzufriedenheit aufrechtzuerhalten.

Ausführlichere Implementierungsanleitungen finden Sie unter:

  • Last updated on