Benutzerdefiniertes Monitoring für bestimmten Anwendungscode hinzufügen


Mit Performance Monitoring werden Traces erfasst, mit denen Sie die Leistung Ihrer App im Blick behalten können. Ein Trace ist ein Bericht mit Leistungsdaten, die zwischen zwei Zeitpunkten in Ihrer App erfasst wurden.

Sie können eigene Traces erstellen, um Leistungsdaten zu überwachen, die mit bestimmten Codeabschnitten in Ihrer App verknüpft sind. Mit einem benutzerdefinierten Code-Trace können Sie messen, wie lange Ihre App für die Ausführung einer bestimmten Aufgabe oder einer Reihe von Aufgaben benötigt, z. B. für das Laden einer Reihe von Bildern oder das Abfragen Ihrer Datenbank.

Der Standardmesswert für einen benutzerdefinierten Code-Trace ist die Dauer (die Zeit zwischen dem Start- und dem Endpunkt des Trace). Sie können aber auch benutzerdefinierte Messwerte hinzufügen.

In Ihrem Code definieren Sie den Anfang und das Ende eines benutzerdefinierten Code-Traces mithilfe der APIs, die vom Performance Monitoring SDK bereitgestellt werden.

Benutzerdefinierte Code-Traces können jederzeit nach ihrer Erstellung gestartet werden und sind threadsicher.

Da der standardmäßig für diese Traces erfasste Messwert „duration“ (Dauer) ist, werden sie manchmal auch als „Duration traces“ (Dauer-Traces) bezeichnet.

Daten aus diesen Traces können Sie auf dem Tab Benutzerdefinierte Traces in der Tracetabelle ansehen. Diese befindet sich unten im Leistungsdashboard. Weitere Informationen zur Verwendung der Console

Standardattribute, benutzerdefinierte Attribute und benutzerdefinierte Messwerte

Bei benutzerdefinierten Code-Traces werden in Performance Monitoring automatisch Standardattribute (allgemeine Metadaten wie App-Version, Land, Gerät usw.) protokolliert, damit Sie die Daten für den Trace in der Firebase Console filtern können. Sie können auch benutzerdefinierte Attribute (z. B. Spiellevel oder Nutzereigenschaften) hinzufügen und beobachten.

Sie können einen benutzerdefinierten Code-Trace weiter konfigurieren, um benutzerdefinierte Messwerte für leistungsbezogene Ereignisse aufzuzeichnen, die im Bereich des Traces auftreten. Sie können beispielsweise einen benutzerdefinierten Messwert für die Anzahl der Cache-Treffer und ‑Fehler oder für die Anzahl der Fälle erstellen, in denen die Benutzeroberfläche für einen spürbaren Zeitraum nicht reagiert.

Benutzerdefinierte Attribute und Messwerte werden in der Firebase Console zusammen mit den Standardattributen und dem Standardmesswert für den Trace angezeigt.

Benutzerdefinierte Code-Traces hinzufügen

Mit der Performance Monitoring Trace API können Sie benutzerdefinierte Code-Traces hinzufügen, um bestimmten Anwendungscode zu überwachen.

Wichtige Hinweise:

  • Eine App kann mehrere benutzerdefinierte Code-Traces haben.
  • Es können mehrere benutzerdefinierte Code-Traces gleichzeitig ausgeführt werden.
  • Namen für benutzerdefinierte Code-Traces müssen die folgenden Anforderungen erfüllen: keine Leerzeichen am Anfang oder Ende, kein Unterstrich (_) am Anfang und eine maximale Länge von 100 Zeichen.
  • Bei benutzerdefinierten Code-Traces können Sie benutzerdefinierte Messwerte und benutzerdefinierte Attribute hinzufügen.

Um einen benutzerdefinierten Code-Trace zu starten und zu beenden, umschließen Sie den Code, den Sie verfolgen möchten, mit Code, der dem folgenden ähnelt:

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

Benutzerdefinierte Messwerte zu benutzerdefinierten Code-Traces hinzufügen

Mit der Performance Monitoring Trace API können Sie benutzerdefinierten Code-Traces benutzerdefinierte Messwerte hinzufügen.

Wichtige Hinweise:

  • Namen für benutzerdefinierte Messwerte müssen die folgenden Anforderungen erfüllen: keine Leerzeichen am Anfang oder Ende, kein Unterstrich (_) am Anfang und eine maximale Länge von 100 Zeichen.
  • Für jeden benutzerdefinierten Code-Trace können bis zu 32 Messwerte erfasst werden, einschließlich des Standardmesswerts Duration (Dauer).

Wenn Sie einen benutzerdefinierten Messwert hinzufügen möchten, fügen Sie jedes Mal, wenn das Ereignis eintritt, eine Codezeile wie die folgende hinzu. Mit diesem benutzerdefinierten Messwert werden beispielsweise leistungsbezogene Ereignisse gezählt, die in Ihrer App auftreten, z. B. Cache-Treffer oder Wiederholungsversuche.

Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();

// Code you want to trace

customTrace.incrementMetric("metric-name", 1);

// More code

await customTrace.stop();

Benutzerdefinierte Attribute für benutzerdefinierte Code-Traces erstellen

Wenn Sie benutzerdefinierte Attribute verwenden möchten, müssen Sie Ihrer App Code hinzufügen, der das Attribut definiert und es einem bestimmten benutzerdefinierten Code-Trace zuordnet. Sie können das benutzerdefinierte Attribut jederzeit zwischen dem Start und dem Ende des Traces festlegen.

Wichtige Hinweise:

  • Namen für benutzerdefinierte Attribute müssen die folgenden Anforderungen erfüllen: keine Leerzeichen am Anfang oder Ende, kein Unterstrich (_) am Anfang und eine maximale Länge von 32 Zeichen.

  • Für jeden benutzerdefinierten Code-Trace können bis zu fünf benutzerdefinierte Attribute erfasst werden.

  • Sie sollten keine benutzerdefinierten Attribute verwenden, die Informationen enthalten, mit denen eine Person gegenüber Google identifiziert werden kann.

Trace trace = FirebasePerformance.instance.newTrace("test_trace");

// Update scenario.
trace.putAttribute("experiment", "A");

// Reading scenario.
String? experimentValue = trace.getAttribute("experiment");

// Delete scenario.
trace.removeAttribute("experiment");

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();

Leistungsdaten erfassen, ansehen und filtern

Bestimmte Messwerte in Ihrem Dashboard im Blick behalten

Wenn Sie sehen möchten, wie sich Ihre wichtigsten Messwerte entwickeln, fügen Sie sie dem Messwertboard oben im Leistungsdashboard hinzu. Sie können Regressionen schnell erkennen, indem Sie sich Änderungen von Woche zu Woche ansehen, oder prüfen, ob sich die Leistung durch die letzten Änderungen an Ihrem Code verbessert hat.

Wenn Sie Ihrem Messwert-Dashboard einen Messwert hinzufügen möchten, rufen Sie in der Firebase Console das Leistungs-Dashboard auf und klicken Sie dann auf den Tab Dashboard. Klicken Sie auf eine leere Messwertkarte und wählen Sie dann einen vorhandenen Messwert aus, den Sie dem Board hinzufügen möchten. Klicken Sie auf einer Messwertkarte mit Daten auf das vertikale Dreipunkt-Menü (⋮), um weitere Optionen aufzurufen, z. B. zum Ersetzen oder Entfernen eines Messwerts.

Im Messwert-Board werden erfasste Messwertdaten im Zeitverlauf sowohl in grafischer Form als auch als numerische prozentuale Änderung dargestellt.

Weitere Informationen zur Verwendung des Dashboards

Traces und zugehörige Daten ansehen

Wenn Sie Ihre Traces ansehen möchten, rufen Sie in der Firebase Console das Leistungs-Dashboard auf, scrollen Sie nach unten zur Tabelle mit den Traces und klicken Sie dann auf den entsprechenden Untertab. In der Tabelle werden einige wichtige Messwerte für jeden Trace angezeigt. Sie können die Liste sogar nach der prozentualen Änderung für einen bestimmten Messwert sortieren.

Wenn Sie in der Tracetabelle auf einen Tracenamen klicken, können Sie verschiedene Bildschirme durchgehen, um den Trace zu analysieren und die gewünschten Messwerte aufzurufen. Auf den meisten Seiten können Sie die Daten mit der Schaltfläche Filter (oben links auf dem Bildschirm) nach Attribut filtern, z. B.:

  • Filtern Sie nach App-Version, um Daten zu einem früheren oder Ihrem neuesten Release aufzurufen.
  • Filtern Sie nach Gerät, um zu sehen, wie ältere Geräte Ihre App verarbeiten.
  • Filtern Sie nach Land, um sicherzustellen, dass der Standort Ihrer Datenbank keine Auswirkungen auf eine bestimmte Region hat.

Weitere Informationen zum Ansehen von Daten für Ihre Traces

Nächste Schritte