Benutzerdefiniertes Monitoring für bestimmten Anwendungscode hinzufügen

Performance Monitoring erfasst Traces, 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, die vom Performance Monitoring SDK bereitgestellt werden. Bei Android-Apps können Sie bestimmte Methoden auch mithilfe der @AddTrace-Anmerkung überwachen. Benutzerdefinierte Code-Traces können nach der Erstellung 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

Sie können einen benutzerdefinierten Code-Trace so konfigurieren, dass benutzerdefinierte Messwerte für leistungsbezogene Ereignisse aufgezeichnet 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-Konsole neben 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 kann mehr als ein benutzerdefinierter Code-Trace gleichzeitig ausgeführt werden.
• Namen für benutzerdefinierte Code-Traces müssen die folgenden Anforderungen erfüllen: keine anführenden oder nachgestellten Leerzeichen, kein anführendes Unterstrichzeichen (_) und eine maximale Länge von 100 Zeichen.
• 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 Codezeilen wie den folgenden. In diesem Beispiel wird der benutzerdefinierte Trace-Name test_trace verwendet:

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace

myTrace.stop()
MainActivity.kt

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace

myTrace.stop();
MainActivity.java

Optional: Bestimmte Methoden mit @AddTrace überwachen

Android-Apps unterstützen auch die Anmerkung @AddTrace, um benutzerdefinierte Code-Traces zu instrumentieren. Bei dieser Funktion beginnt die Ablaufverfolgung am Anfang der angegebenen Methode und endet, wenn die Methode abgeschlossen ist. Dazu gehören auch alle von der Methode aufgerufenen Elemente.

Sie können beispielsweise einen benutzerdefinierten Code-Trace namens onCreateTrace erstellen, der ausgeführt wird, wenn die Methode onCreate() aufgerufen wird.

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
// the `enabled` argument is optional and defaults to true
@AddTrace(name = "onCreateTrace", enabled = true)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}
MainActivity.kt

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}
MainActivity.java

Benutzerdefinierten Code-Traces benutzerdefinierte Messwerte hinzufügen

Verwenden Sie die Performance Monitoring Trace API, um benutzerdefinierten Code-Traces benutzerdefinierte Messwerte hinzuzufü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. Cache-Treffer und -Fehlschläge (mit den Beispielereignisnamen item_cache_hit und item_cache_miss und einem Increment von 1).

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace (and log custom metrics)
val item = cache.fetch("item")
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1)
} else {
    myTrace.incrementMetric("item_cache_miss", 1)
}

myTrace.stop()
MainActivity.kt

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace (and log custom metrics)
Item item = cache.fetch("item");
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1);
} else {
    myTrace.incrementMetric("item_cache_miss", 1);
}

myTrace.stop();
MainActivity.java

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:

  • Keine führenden oder nachgestellten Leerzeichen, kein vorangestelltes Unterstrichzeichen (_)
  • Keine Leerzeichen
  • Darf maximal 32 Zeichen lang sein
  • Zulässige Zeichen für den Namen sind A-Z, a-z und _.

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

• Benutzerdefinierte Attribute dürfen keine Informationen enthalten, die eine Person für Google eindeutig identifizieren.

  Weitere Informationen zu dieser Richtlinie

Firebase.performance.newTrace("test_trace").trace {
    // Update scenario.
    putAttribute("experiment", "A")

    // Reading scenario.
    val experimentValue = getAttribute("experiment")

    // Delete scenario.
    removeAttribute("experiment")

    // Read attributes.
    val traceAttributes = this.attributes
}
MainActivity.kt

Trace trace = FirebasePerformance.getInstance().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();
MainActivity.java

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. Sie können 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.

So fügen Sie Ihrem Messwertbereich einen Messwert hinzu:

1. Rufen Sie in der Firebase-Konsole das Dashboard „Leistung“ auf.
2. Klicken Sie auf eine leere Messwertkarte und wählen Sie einen vorhandenen Messwert aus, um ihn dem Dashboard hinzuzufügen.
3. Klicken Sie auf einer ausgefüllten Messwertkarte auf more_vert, um weitere Optionen aufzurufen, z. B. um einen Messwert zu ersetzen oder zu entfernen.

Auf dem Messwert-Dashboard werden erfasste Messwertdaten im Zeitverlauf sowohl grafisch als auch als numerische prozentuale Änderung dargestellt.

Weitere Informationen zur Verwendung des Dashboards

Traces und ihre Daten ansehen

Wenn Sie sich Ihre Traces ansehen möchten, rufen Sie in der Firebase-Konsole das Dashboard Leistung auf, scrollen Sie nach unten zur Tabelle mit den Traces 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 sogar nach der prozentualen Änderung für einen bestimmten Messwert sortieren.

Performance Monitoring bietet in der Firebase-Konsole eine Seite zur Fehlerbehebung, auf der Messwertänderungen hervorgehoben werden. So können Sie Leistungsprobleme schnell beheben und deren Auswirkungen auf Ihre Apps und Nutzer minimieren. Sie können die Seite zur Fehlerbehebung verwenden, wenn Sie potenzielle Leistungsprobleme feststellen, z. B. in den folgenden Fällen:

• Sie wählen relevante Messwerte im Dashboard aus und stellen eine große Abweichung fest.
• In der Tabelle mit den Traces sortieren Sie die Daten so, dass die größten Deltas oben angezeigt werden. Sie sehen eine deutliche prozentuale Änderung.
• Sie erhalten eine E-Mail-Benachrichtigung über ein Leistungsproblem.

So rufen Sie die Seite zur Fehlerbehebung auf:

• Klicken Sie auf dem Messwert-Dashboard auf die Schaltfläche Messwertdetails ansehen.
• Klicken Sie auf einer Messwertkarte auf more_vert> Details ansehen. Auf der Seite zur Fehlerbehebung werden Informationen zum ausgewählten Messwert angezeigt.
• Klicken Sie in der Tabelle „Traces“ auf einen Trace-Namen oder einen Messwert in der Zeile, die mit diesem Trace verknüpft ist.
• Klicken Sie in einer E-Mail-Benachrichtigung auf Jetzt prüfen.

Wenn Sie in der Tabelle „Traces“ auf einen Trace-Namen klicken, können Sie sich die gewünschten Messwerte ansehen. Klicken Sie auf die Schaltfläche Filteradd, um die Daten nach Attribut zu filtern, z. B.:

• Filtern Sie nach App-Version, um Daten zu einem früheren Release oder Ihrem neuesten Release aufzurufen.
• Filtern Sie nach Gerät, um zu sehen, wie ältere Geräte mit Ihrer App umgehen.
• Filtern Sie nach Land, um sicherzustellen, dass sich der Speicherort Ihrer Datenbank nicht auf eine bestimmte Region auswirkt.

Weitere Informationen zum Ansehen von Daten für Ihre Traces

Nächste Schritte

• Weitere Informationen zur Verwendung von Attributen

• Weitere Informationen zum Überwachen von Leistungsproblemen in der Firebase-Konsole

• Richten Sie Benachrichtigungen 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 eines bestimmten benutzerdefinierten Code-Traces einen von Ihnen festgelegten Grenzwert überschreitet.

• Detaillierte Berichte zu Nutzersitzungen aufrufen, in denen Sie einen bestimmten Trace im Zeitachsenkontext anderer Traces sehen, die während derselben Sitzung erfasst wurden