Benutzerdefiniertes Monitoring für bestimmten Anwendungscode hinzufügen


Performance Monitoring erfasst Traces, damit Sie die Leistung Ihrer Anwendung überwachen können. A Trace ist ein Bericht der Leistungsdaten, die zwischen zwei Zeitpunkten in für Ihre App.

Sie können eigene Traces erstellen, um die Leistungsdaten zu überwachen, Code in Ihrer App. Mit einem benutzerdefinierten Code-Trace können Sie messen, wie wie lange es dauert, bis eine App eine bestimmte Aufgabe oder eine Reihe von Aufgaben erledigt hat, wie das Laden einer Reihe von Bildern oder das Abfragen Ihrer Datenbank.

Der Standardmesswert für einen benutzerdefinierten Code-Trace ist seine „Dauer“ (die Zeit zwischen Start- und Endpunkte des Trace). Sie können jedoch benutzerdefinierte Messwerte.

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 nach ihrer Erstellung jederzeit gestartet werden und Thread-sicher sind.

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

Sie können die Daten dieser Traces auf dem Unter-Tab Benutzerdefinierte Traces der Traces ansehen. Die entsprechende Tabelle finden Sie unten auf dem Dashboard Leistung. über die Console weiter unten auf dieser Seite).

Standardattribute, benutzerdefinierte Attribute und benutzerdefinierte Messwerte

Bei benutzerdefinierten Code-Traces protokolliert Performance Monitoring automatisch Standardattribute (allgemeine Metadaten wie Land, Browser, Seiten-URL usw.), damit Sie die Daten für den Trace in der Firebase-Konsole filtern können. Sie können auch benutzerdefinierte Attribute hinzufügen und überwachen, z. B. Spielebenen oder Nutzereigenschaften.

Sie können ein benutzerdefiniertes Code-Trace weiter konfigurieren, um benutzerdefinierten Messwerten für leistungsbezogene Ereignisse, die im Geltungsbereich des Trace liegen. Sie können beispielsweise einen benutzerdefinierten Messwert für die Anzahl der Cache-Treffer und -Fehler oder die Häufigkeit, mit der die Benutzeroberfläche über einen längeren Zeitraum nicht reagieren.

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

Benutzerdefinierte Code-Traces hinzufügen

Mit der Performance MonitoringTrace 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: 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 Codezeilen wie den folgenden:

Web

import { trace } from "firebase/performance";

const t = trace(perf, "CUSTOM_TRACE_NAME");
t.start();

// Code that you want to trace 
// ...

t.stop();

Web

const trace = perf.trace("CUSTOM_TRACE_NAME");
trace.start();

// Code that you want to trace 
// ...

trace.stop();

Benutzerdefinierte Code-Traces mit der User Timing API hinzufügen

Zusätzlich zur Performance Monitoring Trace API können Sie benutzerdefinierte Code-Traces mithilfe eines natives Format des Browsers User Timing API. Die mit dieser API gemessene Dauer eines Trace wird automatisch vom Performance Monitoring-SDK. Die User Timing API ist besonders hilfreich, um das Performance Monitoring SDK asynchron zu laden. Sobald das SDK initialisiert wurde, zeichnet die vor dem Laden durchgeführten Messungen auf.

Wenn Sie diese Funktion verwenden möchten, umschließen Sie den Code, den Sie erfassen möchten, mit User Timing-Markierungen:

Web

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");

Web

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");

Beachten Sie, dass sich performance im obigen Beispiel auf den Wert des Browsers window.performance-Objekt.

Bei Verwendung der User Timing API können den benutzerdefinierten Code-Traces keine benutzerdefinierten Messwerte und Attribute hinzugefügt werden. Verwenden Sie die Methode Performance Monitoring Trace API, wenn Sie diese benutzerdefinierten Elemente hinzufügen möchten -Elementen zu einem benutzerdefinierten Code-Trace hinzu.

Benutzerdefinierte Messwerte zu benutzerdefinierten Code-Traces 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: kein vorangestelltes oder nachgestelltes Leerzeichen, kein führender Unterstrich (_)-Zeichen, Die maximale Länge beträgt 100 Zeichen.
  • Jeder benutzerdefinierte Code-Trace kann bis zu 32 Messwerte aufzeichnen (einschließlich der Dauer).

Um einen benutzerdefinierten Messwert hinzuzufügen, fügen Sie jedes Mal eine Codezeile ähnlich der folgenden hinzu dass das Ereignis eintritt. Mit diesem benutzerdefinierten Messwert werden beispielsweise leistungsbezogene Ereignisse gezählt, die in Ihrer App auftreten.

Web

import { trace } from "firebase/performance";

async function getInventory(inventoryIds) {
  const t = trace(perf, "inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  t.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  t.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  t.stop();

  return inventoryData;
}

Web

async function getInventory(inventoryIds) {
  const trace = perf.trace("inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  trace.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  trace.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  trace.stop();

  return inventoryData;
}

Benutzerdefinierte Attribute für benutzerdefinierte Code-Traces erstellen

Verwenden Sie die Performance Monitoring Trace API, um benutzerdefinierten Code-Traces benutzerdefinierte Attribute hinzuzufügen.

Wenn Sie benutzerdefinierte Attribute verwenden möchten, fügen Sie Ihrer App Code hinzu, der das Attribut definiert und mit einer bestimmten benutzerdefinierten Code-Spuren verknüpft. Sie können die benutzerdefinierte jederzeit zwischen dem Start des Trace und dem Beenden des Trace.

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 jede benutzerdefinierte Code-Spuren 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

Web

import { trace } from "firebase/performance";

const t = trace(perf, "test_trace");
t.putAttribute("experiment", "A");

// Update scenario
t.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = t.getAttribute("experiment");

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

// Read attributes
const traceAttributes = t.getAttributes();

Web

const trace = perf.trace("test_trace");
trace.putAttribute("experiment", "A");

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

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

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

// Read attributes
const traceAttributes = trace.getAttributes();

Leistungsdaten erfassen, aufrufen und filtern

Wenn du Leistungsdaten in Echtzeit sehen möchtest, achte darauf, dass deine App eine Performance Max-Kampagne Monitoring SDK-Version, die mit der Datenverarbeitung in Echtzeit kompatibel ist. Weitere Informationen zu Echtzeit-Leistungsdaten

Bestimmte Messwerte in Ihrem Dashboard verfolgen

Wenn Sie wissen möchten, wie sich Ihre wichtigsten Messwerte entwickeln, fügen Sie sie Ihrer Messwerttafel oben in der Dashboard zur Leistungsüberwachung Sie können Regressionen schnell erkennen, indem Sie sich wöchentliche oder überprüfen Sie, ob die letzten Änderungen an Ihrem Code die Leistung verbessern.

ein Bild des Messwert-Boards in der Klasse <span class=Firebase Performance Monitoring-Dashboard“

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, den Sie dem Dashboard hinzufügen möchten.
  3. Klicken Sie auf einer ausgefüllten Messwertkarte auf , 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 zugehörige 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 den prozentuale Veränderung für einen bestimmten Messwert.

Performance Monitoring bietet in der Firebase-Konsole eine Seite zur Fehlerbehebung, auf der der Messwert hervorgehoben ist. So lassen sich die Auswirkungen von Leistungsproblemen Apps und Nutzer. Sie können die Seite zur Fehlerbehebung verwenden, wenn Sie Leistungsprobleme auftreten, z. B. in folgenden Szenarien:

  • 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.

Sie haben folgende Möglichkeiten, um auf die Seite zur Fehlerbehebung zuzugreifen:

  • Klicken Sie im Messwert-Dashboard auf die Schaltfläche Messwertdetails ansehen.
  • Klicken Sie auf einer Messwertkarte auf > Details ansehen. Auf der Seite zur Fehlerbehebung werden Informationen zum Messwert angezeigt. die Sie ausgewählt haben.
  • Klicken Sie in der Trace-Tabelle auf einen Trace-Namen oder einen beliebigen Messwert in der zugehörigen Zeile. Trace.
  • 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 die Messwerte aufschlüsseln. Klicken Sie auf das Schaltfläche Filter, um die Daten zu filtern Nach Attribut. Beispiel:

ein Bild von <span class=Firebase Performance Monitoring-Daten werden nach Attribut gefiltert" />
  • Filtern Sie nach Seiten-URL, um Daten für eine bestimmte Seite Ihrer Website aufzurufen.
  • Filtern Sie nach Effektiver Verbindungstyp, um zu sehen, wie sich eine 3G-Verbindung auf Ihre App auswirkt.
  • Filtern Sie nach Land, um sicherzustellen, dass sich der Standort Ihrer Datenbank nicht auf ein bestimmtes Land auswirkt Region

Weitere Informationen über Daten für Ihre Traces.

Nächste Schritte