Benutzerdefiniertes Monitoring für bestimmten Anwendungscode hinzufügen


Beim Leistungsmonitoring werden Traces erfasst, um die Leistung Ihrer App zu überwachen. 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 bestimmtem Code in Ihrer App verknüpft sind. Mit einem benutzerdefinierten Code-Trace können Sie messen, wie lange es dauert, bis Ihre App eine bestimmte Aufgabe oder eine Reihe von Aufgaben erledigt, z. B. das Laden einer Reihe von Bildern oder das Abfragen Ihrer Datenbank.

Der Standardmesswert für einen benutzerdefinierten Code-Trace ist „Dauer“ (die Zeit zwischen dem Start- und Endpunkt des Traces). 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 des Performance Monitoring SDK.

Benutzerdefinierte Code-Traces können nach dem Erstellen jederzeit gestartet werden und sind threadsicher.

Da für diese Protokolle standardmäßig der Messwert „Dauer“ erfasst wird, werden sie manchmal auch als „Dauerprotokolle“ bezeichnet.

Sie können Daten aus diesen Traces auf dem Untertab Benutzerdefinierte Traces der Traces-Tabelle unten im Dashboard Leistung aufrufen. Weitere Informationen zur Verwendung der Console finden Sie weiter unten auf dieser Seite.

Standardattribute, benutzerdefinierte Attribute und benutzerdefinierte Messwerte

Bei benutzerdefinierten Code-Traces werden beim Leistungsmonitoring automatisch Standardattribute (gemeinsame 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 hinzufügen und überwachen, z. B. Spielebenen oder Nutzereigenschaften.

Sie können einen benutzerdefinierten Code-Trace so konfigurieren, dass benutzerdefinierte Messwerte für leistungsbezogene Ereignisse erfasst werden, die im Gültigkeitsbereich des Tracings auftreten. Sie können beispielsweise einen benutzerdefinierten Messwert für die Anzahl der Cache-Treffer und ‑Ausfälle oder für die Häufigkeit erstellen, mit der die Benutzeroberfläche für einen längeren Zeitraum nicht reagiert.

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

Benutzerdefinierte Code-Traces hinzufügen

Mit der Trace API für die Leistungsüberwachung können Sie benutzerdefinierte Code-Traces hinzufügen, um bestimmten Anwendungscode zu überwachen.

Wichtige Hinweise:

  • Eine App kann mehrere benutzerdefinierte Code-Traces haben.
  • Es kann mehr als ein benutzerdefinierter Code-Trace gleichzeitig ausgeführt werden.
  • Namen für benutzerdefinierte Code-Traces müssen die folgenden Anforderungen erfüllen: Sie dürfen keine führenden oder abschließenden Leerzeichen, keinen führenden Unterstrich (_) und eine maximale Länge von 100 Zeichen haben.
  • Benutzerdefinierte Code-Traces unterstützen das Hinzufügen von benutzerdefinierten Messwerten und benutzerdefinierten Attributen.

Wenn Sie eine benutzerdefinierte Code-Spur starten und beenden möchten, umschließen Sie den Code, den Sie erfassen möchten, mit Code wie dem folgenden:

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

// Code you want to trace

await customTrace.stop();

Benutzerdefinierten Code-Traces benutzerdefinierte Messwerte hinzufügen

Mit der Trace API für die Leistungsüberwachung können Sie benutzerdefinierten Code-Traces benutzerdefinierte Messwerte hinzufügen.

Wichtige Hinweise:

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

Wenn Sie einen benutzerdefinierten Messwert hinzufügen möchten, fügen Sie jedes Mal, wenn das Ereignis eintritt, eine Codezeile hinzu, die der folgenden ähnelt. Mit diesem benutzerdefinierten Messwert werden beispielsweise leistungsbezogene Ereignisse in Ihrer App gezählt, z. B. Cachetreffer 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();

Benutzerdefinierte Attribute für benutzerdefinierte Code-Traces erstellen

Wenn Sie benutzerdefinierte Attribute verwenden möchten, fügen Sie Ihrer App Code hinzu, der das Attribut definiert und mit einer bestimmten benutzerdefinierten Code-Spurenverknüpfung verknüpft. Sie können das benutzerdefinierte Attribut jederzeit zwischen dem Start und dem Ende der Aufzeichnung festlegen.

Wichtige Hinweise:

  • Namen für benutzerdefinierte Attribute müssen die folgenden Anforderungen erfüllen: Vor- oder nachgestellte Leerzeichen, Unterstriche (_) dürfen nicht vorangestellt werden und die maximale Länge beträgt 32 Zeichen.

  • Für jede benutzerdefinierte Code-Spuren können bis zu fünf benutzerdefinierte Attribute erfasst werden.

  • 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 erfassen, ansehen und filtern

Bestimmte Messwerte im Dashboard beobachten

Wenn Sie wissen möchten, wie sich Ihre wichtigsten Messwerte entwickeln, fügen Sie sie oben im Dashboard Leistung Ihrem Messwertbereich hinzu. So können Sie schnell Regressionen erkennen, indem Sie die Änderungen von Woche zu Woche analysieren, oder prüfen, ob die Leistung durch die letzten Änderungen am Code verbessert wurde.

Wenn Sie Ihrem Messwert-Board einen Messwert hinzufügen möchten, rufen Sie in der Firebase Console das Dashboard Leistung auf und klicken Sie dann auf den Tab Dashboard. Klicken Sie auf eine leere Messwertkarte und wählen Sie einen vorhandenen Messwert aus, den Sie Ihrem Dashboard hinzufügen möchten. Klicken Sie auf der Karte mit dem Messwert auf die drei untereinander angeordneten Punkte (⋮), um weitere Optionen aufzurufen und z. B. einen Messwert zu ersetzen oder zu entfernen.

Auf dem Messwert-Dashboard werden erfasste Messwertdaten im Zeitverlauf sowohl in grafischer Form als auch als numerische prozentuale Änderung angezeigt.

Weitere Informationen zur Verwendung des Dashboards

Traces und ihre Daten ansehen

Rufen Sie zum Ansehen Ihrer Traces das Dashboard Leistung in der Firebase Console auf, scrollen Sie nach unten zur Traces-Tabelle und klicken Sie dann auf den entsprechenden Untertab. In der Tabelle werden einige der wichtigsten Messwerte für jeden Trace angezeigt. Sie können die Liste auch nach der prozentualen Änderung für einen bestimmten Messwert sortieren.

Wenn Sie in der Trace-Tabelle auf einen Tracenamen klicken, können Sie zwischen verschiedenen Bildschirmen wechseln, um den Trace zu erkunden und die relevanten Messwerte aufzuschlüsseln. Auf den meisten Seiten können Sie die Daten mithilfe 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 aktuellen Release aufzurufen.
  • Filtern Sie nach Gerät, um zu sehen, wie ältere Geräte mit Ihrer App umgehen.
  • Filtern Sie nach Land, um festzustellen, ob sich der Speicherort Ihrer Datenbank auf eine bestimmte Region auswirkt.

Weitere Informationen zum Aufrufen von Trace-Daten

Nächste Schritte