Aggiungere il monitoraggio personalizzato per un codice dell'app specifico

iOS+ Android Web Flutter

Performance Monitoring raccoglie le tracce per aiutarti a monitorare il rendimento della tua app. Una traccia è un report dei dati sul rendimento acquisiti tra due istanti nella tua app.

Puoi creare le tue tracce per monitorare i dati sul rendimento associati a codice specifico nella tua app. Con una traccia di codice personalizzata, puoi misurare il tempo necessario alla tua app per completare un'attività specifica o un insieme di attività, ad esempio il caricamento di un insieme di immagini o l'esecuzione di query sul database.

La metrica predefinita per una traccia di codice personalizzata è la "durata" (il tempo tra i punti di inizio e di arresto della traccia), ma puoi anche aggiungere metriche personalizzate.

Nel codice, definisci l'inizio e la fine di una traccia di codice personalizzata utilizzando le API fornite dall'SDK Performance Monitoring. Per le app per Android, puoi anche monitorare metodi specifici utilizzando l'annotazione @AddTrace. Le tracce di codice personalizzato possono essere avviate in qualsiasi momento dopo la loro creazione e sono sicure per i thread.

Poiché la metrica predefinita raccolta per queste tracce è "duration", a volte vengono chiamate "tracce Duration".

Puoi visualizzare i dati di queste tracce nella sottoscheda Tracce personalizzate della tabella delle tracce, che si trova nella parte inferiore della dashboard Rendimento (scopri di più sull'utilizzo della console più avanti in questa pagina).

Nota: l'avvio e l'arresto delle tracce troppo rapidamente può richiedere molte risorse, quindi devi evitare di creare tracce di codice personalizzate ad alta frequenza (ad esempio, una volta per frame nei giochi).

Attributi predefiniti, attributi personalizzati e metriche personalizzate

Per le tracce di codice personalizzate, Performance Monitoring registra automaticamente gli attributi predefiniti (metadati comuni come versione dell'app, paese, dispositivo e così via) in modo da poter filtrare i dati relativi alla traccia nella console Firebase. Puoi anche aggiungere e monitorare attributi personalizzati (ad esempio, il livello del gioco o le proprietà utente).

Puoi configurare ulteriormente una traccia di codice personalizzata per registrare metriche personalizzate per gli eventi correlati al rendimento che si verificano nell'ambito della traccia. Ad esempio, puoi creare una metrica personalizzata per il numero di hit e mancate hit della cache o per il numero di volte in cui l'interfaccia utente diventa non rispondente per un periodo di tempo significativo.

Gli attributi e le metriche personalizzate vengono visualizzati nella console Firebase insieme agli attributi e alla metrica predefiniti per la traccia.

Un attributo è un valore di stringa che ti aiuta a filtrare e segmentare i dati nella console. Una metrica è un valore numerico che può essere rappresentato in un grafico e misurato nel tempo.

Aggiungere tracce di codice personalizzate

Utilizza l'Performance Monitoring API Trace per aggiungere tracce di codice personalizzate per monitorare un codice dell'applicazione specifico.

Tieni presente quanto segue:

• Un'app può avere più tracce di codice personalizzate.
• È possibile eseguire più tracce di codice personalizzate contemporaneamente.
• I nomi delle tracce di codice personalizzato devono soddisfare i seguenti requisiti: nessun carattere iniziale o finale di spazio, nessun carattere iniziale di trattino basso (_) e una lunghezza massima di 100 caratteri.
• Le tracce di codice personalizzate supportano l'aggiunta di metriche personalizzate e attributi personalizzati.

Per avviare e interrompere una traccia di codice personalizzata, racchiudi il codice da tracciare con linee di codice simili alle seguenti (questo esempio utilizza un nome di traccia personalizzata ditest_trace):

Kotlin+KTX

// 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

Java

// 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

(Facoltativo) Monitora metodi specifici utilizzando @AddTrace

Le app per Android supportano anche l'@AddTrace annotazione per analizzare le tracce di codice personalizzato. Con questa funzionalità, la traccia inizia all'inizio del metodo specificato e si interrompe al termine del metodo, inclusi tutti gli elementi richiamati dal metodo.

Nota: per le tracce di codice personalizzate sottoposte a ispezione utilizzando l'annotazione @AddTrace, non puoi aggiungere metriche o attributi personalizzati.

Ad esempio, puoi creare una traccia di codice personalizzata denominata onCreateTrace che viene eseguita quando viene chiamato il metodo onCreate().

Kotlin+KTX

// 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

Java

// 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

Aggiungere metriche personalizzate alle tracce di codice personalizzato

Utilizza l'Performance Monitoring API Trace per aggiungere metriche personalizzate alle tracce di codice personalizzate.

Tieni presente quanto segue:

• I nomi delle metriche personalizzate devono soddisfare i seguenti requisiti: nessun carattere di spazio iniziale o finale, nessun carattere iniziale di trattino basso (_) e la lunghezza massima è di 100 caratteri.
• Ogni traccia di codice personalizzata può registrare fino a 32 metriche (inclusa la metrica predefinita Durata).

Per aggiungere una metrica personalizzata, aggiungi una riga di codice simile alla seguente ogni volta che si verifica l'evento. Ad esempio, questa metrica personalizzata conteggia gli eventi correlati al rendimento che si verificano nella tua app, ad esempio hit e mancate corrispondenze della cache (utilizzando i nomi di eventi di esempio item_cache_hit e item_cache_miss e un incremento di 1).

Kotlin+KTX

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

Java

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

Creare attributi personalizzati per le tracce di codice personalizzate

Utilizza l'Performance Monitoring API Trace per aggiungere attributi personalizzati alle tracce di codice personalizzate.

Per utilizzare gli attributi personalizzati, aggiungi alla tua app del codice che definisce l'attributo e lo associa a una traccia di codice personalizzata specifica. Puoi impostare l'attributo personalizzato in qualsiasi momento tra l'inizio e la fine della traccia.

Tieni presente quanto segue:

• I nomi degli attributi personalizzati devono soddisfare i seguenti requisiti:

  • Nessuno spazio iniziale o finale, nessun carattere trattino basso (_) iniziale
  • Nessuno spazio
  • La lunghezza massima è di 32 caratteri
  • I caratteri consentiti per il nome sono A-Z, a-z e _.

• Ogni traccia di codice personalizzato può registrare fino a 5 attributi personalizzati.

• Assicurati che gli attributi personalizzati non contengano informazioni che consentono l'identificazione personale di un individuo per Google.

  Scopri di più su queste linee guida

  Raccolta dei dati utente: Performance Monitoring non raccoglie da sola informazioni che consentono l'identificazione personale (PII), come nomi, indirizzi email o numeri di telefono. Gli sviluppatori possono raccogliere dati aggiuntivi utilizzando Performance Monitoring creando attributi personalizzati nelle tracce di codice personalizzato. Questi dati raccolti tramite Performance Monitoring non devono contenere informazioni che consentono l'identificazione personale di un individuo per Google.

  Ecco un esempio di messaggio di log che non contiene informazioni che consentono l'identificazione personale:

  trace.putAttribute("experiment", "A");

  Ecco un esempio che contiene informazioni che consentono l'identificazione personale (non utilizzare questo tipo di attributo personalizzato nella tua app):

  trace.putAttribute("email", user.getEmailAddress());

  I dati che mostrano informazioni che consentono l'identificazione personale sono soggetti all'eliminazione senza preavviso.

Kotlin+KTX

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

Java

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

Monitorare, visualizzare e filtrare i dati sul rendimento

Monitorare metriche specifiche nella dashboard

Per conoscere le tendenze delle tue metriche principali, aggiungile alla scheda delle metriche nella parte superiore della dashboard Rendimento. Puoi identificare rapidamente le regressioni monitorando le variazioni di settimana in settimana o verificare che le modifiche recenti al codice stiano migliorando il rendimento.

Dashboard di Firebase Performance Monitoring" />

Per aggiungere una metrica alla scheda delle metriche:

1. Vai alla dashboard Rendimentonella console Firebase.
2. Fai clic su una scheda metrica vuota, quindi seleziona una metrica esistente da aggiungere alla scheda.
3. Fai clic su in una scheda delle metriche compilata per visualizzare altre opzioni, ad esempio per sostituire o rimuovere una metrica.

La scheda delle metriche mostra i dati delle metriche raccolti nel tempo, sia in forma grafica sia come variazione percentuale numerica.

Scopri di più sull'utilizzo della dashboard.

Visualizzare le tracce e i relativi dati

Per visualizzare le tracce, vai alla dashboard Rendimento nella console Firebase, scorri verso il basso fino alla tabella delle tracce e fai clic sulla sottoscheda appropriata. La tabella mostra alcune metriche principali per ogni traccia e puoi anche ordinare l'elenco in base alla variazione percentuale di una metrica specifica.

Performance Monitoring fornisce una pagina per la risoluzione dei problemi nella console Firebase che mette in evidenza le variazioni delle metriche, consentendo di risolvere rapidamente e ridurre al minimo l'impatto dei problemi di prestazioni sulle tue app e sui tuoi utenti. Puoi utilizzare la pagina di risoluzione dei problemi quando vengono rilevati potenziali problemi di prestazioni, ad esempio nei seguenti scenari:

• Seleziona le metriche pertinenti nella dashboard e noti un delta elevato.
• Nella tabella delle tracce, ordina in modo da visualizzare i delta più grandi in alto e vedi una variazione percentuale significativa.
• Ricevi un avviso via email che ti informa di un problema di rendimento.

Puoi accedere alla pagina di risoluzione dei problemi nei seguenti modi:

• Nella dashboard delle metriche, fai clic sul pulsante Visualizza i dettagli della metrica.
• In qualsiasi scheda delle metriche, seleziona => Visualizza dettagli. La pagina di risoluzione dei problemi mostra informazioni sulla metrica selezionata.
• Nella tabella delle tracce, fai clic sul nome di una traccia o su un valore della metrica nella riga associata alla traccia.
• In un avviso via email, fai clic su Esegui accertamenti ora.

Quando fai clic sul nome di una traccia nella tabella delle tracce, puoi visualizzare in dettaglio le metriche di interesse. Fai clic sul pulsante Filtra per filtrare i dati per attributo, ad esempio:

Dati di Firebase Performance Monitoring filtrati per attributo" />

• Filtra per Versione app per visualizzare i dati relativi a una release precedente o alla release più recente
• Filtra per Dispositivo per scoprire in che modo i dispositivi meno recenti gestiscono la tua app
• Filtra in base a Paese per assicurarti che la posizione del database non influisca su una regione specifica.

Scopri di più su come visualizzare i dati delle tue tracce.

Passaggi successivi

• Scopri di più sull'utilizzo degli attributi per esaminare i dati sul rendimento.

• Scopri di più su come monitorare i problemi di rendimento nella consoleFirebase.

• Configura avvisi per le modifiche al codice che stanno peggiorando il rendimento della tua app. Ad esempio, puoi configurare un avviso via email per il tuo team se la durata di una traccia di codice personalizzato specifica supera una soglia impostata.

• Visualizza report dettagliati sulle sessioni utente in cui puoi vedere una traccia specifica nel contesto di una sequenza temporale di altre tracce raccolte durante la stessa sessione.