Fügen Sie eine benutzerdefinierte Überwachung für bestimmten App-Code hinzu

Die Leistungsüberwachung sammelt Ablaufverfolgungen , um Ihnen bei der Überwachung der Leistung Ihrer App zu helfen. Eine Ablaufverfolgung ist ein Bericht von Leistungsdaten, die zwischen zwei Zeitpunkten in Ihrer App erfasst wurden.

Sie können Ihre eigenen Ablaufverfolgungen erstellen, um Leistungsdaten zu überwachen, die mit bestimmtem Code in Ihrer App verknüpft sind. Mit einem benutzerdefinierten Code-Trace können Sie messen, wie lange Ihre App benötigt, um eine bestimmte Aufgabe oder eine Reihe von Aufgaben auszuführen, z. B. das Laden einer Reihe von Bildern oder das Abfragen Ihrer Datenbank.

Die Standardmetrik für einen benutzerdefinierten Code-Trace ist seine „Dauer“ (die Zeit zwischen den Start- und Stopppunkten des Trace), aber Sie können auch benutzerdefinierte Metriken hinzufügen.

In Ihrem Code definieren Sie den Anfang und das Ende einer Ablaufverfolgung für benutzerdefinierten Code mithilfe der vom Performance Monitoring SDK bereitgestellten APIs.

Traces für benutzerdefinierten Code können nach ihrer Erstellung jederzeit gestartet werden und sind Thread-sicher.

Da die für diese Traces erfasste Standardmetrik „Dauer“ ist, werden sie manchmal als „Dauer-Traces“ bezeichnet.

Sie können Daten aus diesen Ablaufverfolgungen auf der Unterregisterkarte Benutzerdefinierte Ablaufverfolgungen der Ablaufverfolgungstabelle anzeigen, die sich unten im Leistungs- Dashboard befindet (weitere Informationen zur Verwendung der Konsole finden Sie weiter unten auf dieser Seite).

Standardattribute, benutzerdefinierte Attribute und benutzerdefinierte Metriken

Für Ablaufverfolgungen von benutzerdefiniertem Code protokolliert die Leistungsüberwachung automatisch Standardattribute (gemeinsame Metadaten wie App-Version, Land, Gerät usw.), sodass Sie die Daten für die Ablaufverfolgung in der Firebase-Konsole filtern können. Sie können auch benutzerdefinierte Attribute (z. B. Spiellevel oder Benutzereigenschaften) hinzufügen und überwachen.

Sie können eine Ablaufverfolgung für benutzerdefinierten Code weiter konfigurieren, um benutzerdefinierte Metriken für leistungsbezogene Ereignisse aufzuzeichnen, die im Geltungsbereich der Ablaufverfolgung auftreten. Sie können beispielsweise eine benutzerdefinierte Metrik für die Anzahl der Cache-Treffer und -Fehlschläge oder die Häufigkeit erstellen, mit der die Benutzeroberfläche für einen merklichen Zeitraum nicht mehr reagiert.

Benutzerdefinierte Attribute und benutzerdefinierte Metriken werden in der Firebase-Konsole neben den Standardattributen und der Standardmetrik für die Ablaufverfolgung angezeigt.

Fügen Sie benutzerdefinierte Codespuren hinzu

Verwenden Sie die Performance Monitoring Trace API, um benutzerdefinierte Code-Traces hinzuzufügen, um bestimmten Anwendungscode zu überwachen.

Beachte das Folgende:

• Eine App kann mehrere benutzerdefinierte Codeablaufverfolgungen aufweisen.
• Es kann mehr als eine Ablaufverfolgung für benutzerdefinierten Code gleichzeitig ausgeführt werden.
• Namen für benutzerdefinierte Codeablaufverfolgungen müssen die folgenden Anforderungen erfüllen: keine führenden oder abschließenden Leerzeichen, kein führender Unterstrich ( _ ) und eine maximale Länge von 100 Zeichen.
• Traces für benutzerdefinierten Code unterstützen das Hinzufügen von benutzerdefinierten Metriken und benutzerdefinierten Attributen .

Um eine Ablaufverfolgung für benutzerdefinierten Code zu starten und zu stoppen, umschließen Sie den zu verfolgenden Code mit Code ähnlich dem folgenden:

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

// Code you want to trace

await customTrace.stop();

Fügen Sie benutzerdefinierte Metriken zu benutzerdefinierten Code-Traces hinzu

Verwenden Sie die Leistungsüberwachungs-Trace-API, um benutzerdefinierte Metriken zu benutzerdefinierten Code-Traces hinzuzufügen.

Beachte das Folgende:

• Namen für benutzerdefinierte Metriken müssen die folgenden Anforderungen erfüllen: keine führenden oder abschließenden Leerzeichen, kein führender Unterstrich ( _ ) und eine maximale Länge von 100 Zeichen.
• Jede Ablaufverfolgung für benutzerdefinierten Code kann bis zu 32 Metriken aufzeichnen (einschließlich der standardmäßigen Duration- Metrik).

Um eine benutzerdefinierte Metrik hinzuzufügen, fügen Sie jedes Mal, wenn das Ereignis auftritt, eine Codezeile ähnlich der folgenden hinzu. Diese benutzerdefinierte Metrik zählt beispielsweise leistungsbezogene Ereignisse, die in Ihrer App auftreten, wie z. B. Cache-Treffer oder Wiederholungen.

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();

Erstellen Sie benutzerdefinierte Attribute für benutzerdefinierte Codeablaufverfolgungen

Um benutzerdefinierte Attribute zu verwenden, fügen Sie Ihrer App Code hinzu, der das Attribut definiert und es einem bestimmten benutzerdefinierten Code-Trace zuordnet. Sie können das benutzerdefinierte Attribut jederzeit zwischen dem Beginn und dem Stoppen der Ablaufverfolgung festlegen.

Beachte das Folgende:

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

• Jede Ablaufverfolgung für benutzerdefinierten Code kann bis zu 5 benutzerdefinierte Attribute aufzeichnen.

• Sie sollten keine benutzerdefinierten Attribute verwenden, die Informationen enthalten, die eine Person für Google persönlich identifizieren.

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 verfolgen, anzeigen und filtern

Verfolgen Sie bestimmte Metriken in Ihrem Dashboard

Um zu erfahren, wie sich Ihre wichtigsten Metriken entwickeln, fügen Sie sie zu Ihrem Metrik-Board oben im Leistungs- Dashboard hinzu. Sie können Regressionen schnell erkennen, indem Sie Änderungen von Woche zu Woche sehen oder überprüfen, ob die letzten Änderungen in Ihrem Code die Leistung verbessern.

Um Ihrem Metrik-Board eine Metrik hinzuzufügen, gehen Sie in der Firebase-Konsole zum Leistungs- Dashboard und klicken Sie dann auf die Registerkarte Dashboard . Klicken Sie auf eine leere Metrikkarte und wählen Sie dann eine vorhandene Metrik aus, die Sie Ihrem Board hinzufügen möchten. Klicken Sie auf die vertikalen Auslassungspunkte ( ⋮ ) auf einer gefüllten Metrikkarte, um weitere Optionen anzuzeigen, z. B. das Ersetzen oder Entfernen einer Metrik.

Das Metrik-Board zeigt gesammelte Metrikdaten im Laufe der Zeit, sowohl in grafischer Form als auch als numerische prozentuale Veränderung.

Erfahren Sie mehr über die Verwendung des Dashboards .

Traces und ihre Daten anzeigen

Um Ihre Ablaufverfolgungen anzuzeigen, gehen Sie zum Leistungs- Dashboard in der Firebase-Konsole, scrollen Sie nach unten zur Ablaufverfolgungstabelle und klicken Sie dann auf die entsprechende Unterregisterkarte. Die Tabelle zeigt einige Top-Metriken für jede Ablaufverfolgung, und Sie können die Liste sogar nach der prozentualen Änderung für eine bestimmte Metrik sortieren.

Wenn Sie in der Trace-Tabelle auf einen Trace-Namen klicken, können Sie sich durch verschiedene Bildschirme klicken, um den Trace zu untersuchen und einen Drilldown zu interessanten Metriken durchzuführen. Auf den meisten Seiten können Sie die Filter- Schaltfläche (oben links auf dem Bildschirm) verwenden, um die Daten nach Attributen zu filtern, zum Beispiel:

• Filtern Sie nach App-Version , um Daten zu einer früheren Version oder Ihrer neuesten Version anzuzeigen
• Filtern Sie nach Gerät , um zu erfahren, wie ältere Geräte mit Ihrer App umgehen
• Filtern Sie nach Land, um sicherzustellen, dass sich Ihr Datenbankstandort nicht auf eine bestimmte Region auswirkt

Erfahren Sie mehr über das Anzeigen von Daten für Ihre Spuren .

Nächste Schritte

• Erfahren Sie mehr über die Verwendung von Attributen zur Untersuchung von Leistungsdaten.

• Erfahren Sie mehr darüber, wie Sie Leistungsprobleme in der Firebase-Konsole nachverfolgen .

• Richten Sie Warnungen für Codeänderungen ein , die die Leistung Ihrer App beeinträchtigen. Sie können beispielsweise eine E-Mail-Benachrichtigung für Ihr Team konfigurieren, wenn die Dauer einer bestimmten benutzerdefinierten Codeablaufverfolgung einen von Ihnen festgelegten Schwellenwert überschreitet.