Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS e versioni successive Android Flusso Unità

Nella dashboard di Crashlytics, puoi fare clic su un problema e visualizzare report sugli eventi. Puoi personalizzare questi report per comprendere meglio ciò che accade nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

• Instrumenta la tua app per registrare chiavi personalizzate, messaggi di log personalizzati e identificatori utente.

• Segnala le eccezioni a Crashlytics.

• Ricevi automaticamente i log dei breadcrumb se la tua app utilizza la classe SDK Firebase per Google Analytics. Questi log ti consentono di monitorare le azioni degli utenti che precedono un evento raccolto da Crashlytics nella tua app.

• Disattivare i report automatici sugli arresti anomali e abilitare i report di attivazione per i tuoi utenti. Tieni presente che, per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app.

Aggiungere chiavi personalizzate

Le chiavi personalizzate ti consentono di conoscere lo stato specifico della tua app che ha causato un arresto anomalo. Puoi associare coppie chiave/valore arbitrarie ai report sugli arresti anomali, quindi utilizzare le chiavi personalizzate per cercare e filtrare i report sugli arresti anomali nella console Firebase.

• Nella dashboard di Crashlytics, puoi cercare i problemi. che corrispondono a una chiave personalizzata.

• Quando esamini un problema specifico nella console, puoi visualizzare chiavi personalizzate associate a ogni evento (scheda Chiavi) e persino filtrare gli eventi per chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Dopo aver raggiunto questa soglia, i valori aggiuntivi non vengono salvati. Ogni coppia chiave/valore può avere una dimensione massima di 1 kB.

Utilizza il metodo dell'istanza setCustomKey per impostare le coppie chiave/valore. Tieni presente che setCustomKey è sovraccaricato per il parametro value in modo da accettare qualsiasi argomento primitivo o String. Ecco alcuni esempi:

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("my_string_key", "foo") // String value
    key("my_bool_key", true) // boolean value
    key("my_double_key", 1.0) // double value
    key("my_float_key", 1.0f) // float value
    key("my_int_key", 1) // int value
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("my_string_key", "foo" /* string value */);

crashlytics.setCustomKey("my_bool_key", true /* boolean value */);

crashlytics.setCustomKey("my_double_key", 1.0 /* double value */);

crashlytics.setCustomKey("my_float_key", 1.0f /* float value */);

crashlytics.setCustomKey("my_int_key", 1 /* int value */);

Puoi anche modificare il valore di una chiave esistente chiamandola e impostandola su un valore diverso. Ad esempio:

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Aggiungi più coppie chiave/valore passando un'istanza di CustomKeysAndValues al metodo di istanza setCustomKeys:

Kotlin+KTX

Per Kotlin, la funzionalità esistente è più semplice che utilizzare Builder di CustomKeysAndValues.

crashlytics.setCustomKeys {
  key("str_key", "hello")
  key("bool_key", true)
  key("int_key", 1)
  key("long_key", 1L)
  key("float_key", 1.0f)
  key("double_key", 1.0)
}

Java

CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
.putString("string key", "string value")
.putString("string key 2", "string  value 2")
.putBoolean("boolean key", True)
.putBoolean("boolean key 2", False)
.putFloat("float key", 1.01)
.putFloat("float key 2", 2.02)
.build();

FirebaseCrashlytics.getInstance().setCustomKeys(keysAndValues);

Aggiungere messaggi di log personalizzati

Per darti maggiore contesto sugli eventi che hanno portato a un arresto anomalo, puoi aggiungere log Crashlytics personalizzati nella tua app. Crashlytics associa i log con i dati relativi agli arresti anomali e li visualizza nella pagina Crashlytics dell' Console Firebase, nella scheda Log.

Nota: per evitare di rallentare l'app, Crashlytics limita i log a 64 kB ed elimina le voci di log meno recenti quando i log di una sessione superano questo limite.

Usa log per individuare i problemi. Ad esempio:

Kotlin+KTX

Firebase.crashlytics.log("message")

Java

FirebaseCrashlytics.getInstance().log("message");

Impostare gli identificatori utente

Per diagnosticare un problema, spesso è utile sapere quali utenti hanno riscontrato a un determinato arresto anomalo. Crashlytics include un modo per identificare in modo anonimo gli utenti in i tuoi report sugli arresti anomali.

Per aggiungere gli ID utente ai report, assegna a ciascun utente un identificatore univoco nella di un numero ID, di un token o di un valore hash:

Kotlin+KTX

Firebase.crashlytics.setUserId("user123456789")

Java

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Se devi cancellare un identificatore utente dopo averlo impostato, reimposta il valore su una stringa vuota. La cancellazione di un identificatore utente non rimuove i valori esistenti Crashlytics record. Se devi eliminare i record associati a un ID utente, contatta l'assistenza Firebase.

(Solo Android NDK) Aggiungere metadati ai report sugli arresti anomali di NDK

Se vuoi, puoi includere l'intestazione crashlytics.h nel codice C++ per aggiungere metadati ai report sugli arresti anomali NDK, ad esempio chiavi personalizzate, log personalizzati, identificatori utente. Tutte queste opzioni sono descritte sopra in questa pagina.

crashlytics.h è disponibile come libreria C++ solo con intestazioni nel repository GitHub dell'SDK Firebase per Android.

Leggi i commenti nel file di intestazione per istruzioni sull'utilizzo delle API C++ NDK.

Includi report GWP-ASan per eseguire il debug dei problemi di danneggiamento della memoria

Crashlytics può aiutarti a eseguire il debug degli arresti anomali causati da errori di memoria nativi raccogliendo i report GWP-ASan. Questi errori relativi alla memoria possono essere associati al danneggiamento della memoria all'interno dell'app, che è la causa principale delle vulnerabilità della sicurezza delle app.

• Puoi visualizzare questi dati in una nuova scheda "Tracce dello stack della memoria" quando fai clic sui dettagli di un problema nella dashboard Crashlytics.

• Puoi anche utilizzare il nuovo indicatore e filtro "Report GWP-ASan" per visualizzare rapidamente tutti i problemi relativi a questi dati.

Puoi ricevere report sulla memoria GWP-ASan se attivare esplicitamente GWP-ASan nella tua app e utilizza l'SDK Crashlytics per NDK 18.3.6 o versioni successive (Firebase BoM versione 31.3.0 e successive). Puoi testare la tua configurazione GWP-ASan utilizzando il esempio di codice nativo nella documentazione di Android.

Segnala le eccezioni non fatali

Oltre a segnalare automaticamente gli arresti anomali dell'app, Crashlytics consente di registrare le eccezioni non fatali e di inviartele al successivo avvio dell'app.

Nota: Crashlytics memorizza solo le otto eccezioni registrate più recenti. Se l'app genera più di otto eccezioni, mentre le eccezioni meno recenti vengono perse.

Utilizza il metodo recordException per registrare eccezioni non irreversibili nell'account catch blocchi. Ad esempio:

Kotlin+KTX

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

Java

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Avviso: se vuoi includere un valore univoco (ad esempio un ID utente o un timestamp) nel messaggio di eccezione, utilizza una chiave personalizzata anziché aggiungere il valore direttamente nel messaggio di eccezione. L'aggiunta diretta di valori può diversi problemi e potrebbe causare la limitazione da parte di Crashlytics degli errori nei report .

Tutte le eccezioni registrate vengono visualizzate come problemi non irreversibili nella console Firebase. Il riepilogo del problema contiene tutte le informazioni sullo stato che ricevi normalmente arresti anomali, oltre ad analisi per versione di Android e dispositivo hardware.

Crashlytics elabora le eccezioni in un thread in background dedicato per minimizzare l'impatto sulle prestazioni della tua app. Per ridurre il traffico di rete degli utenti, Crashlytics raggruppa le eccezioni registrate e le invia la volta successiva che l'app viene avviata.

Recupera log dei breadcrumb

I log dei breadcrumb offrono una migliore comprensione delle interazioni di un utente ha avuto con la tua app e ha causato un evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utile quando si cerca di riprodurre un problema ed eseguirne il debug.

I log breadcrumb sono basati su Google Analytics, quindi per ottenerli devi attivare Google Analytics per il tuo progetto Firebase e aggiungere l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i log breadcrumb vengono inclusi automaticamente con i dati di un evento nella scheda Log quando visualizzi i dettagli di un problema.

L'SDK Analytics registra automaticamente l'evento screen_view che consente ai log dei breadcrumb di mostrare un elenco delle schermate visualizzate prima del di un evento di arresto anomalo, non irreversibile o ANR. Un log dei breadcrumb screen_view contiene un parametro firebase_screen_class.

I log dei breadcrumb vengono anche compilati con qualsiasi eventi personalizzati che registri manualmente nell'account dell'utente. sessione, inclusi i dati dei parametri dell'evento. Questi dati possono essere utili per mostrare una serie di azioni utente che hanno portato a un arresto anomalo, a un evento non irreversibile o ANR.

Tieni presente che puoi controllare la raccolta e l'utilizzo dei dati di Google Analytics, che includono i dati che popolano i log dei breadcrumb.

Attivare i report di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali relativi a tutti i tuoi utenti dell'app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi attivare attiva la generazione di report disattivando la generazione di report automatici e inviando dati solo a Crashlytics quando scegli nel codice:

1. Nel blocco application del file AndroidManifest.xml, aggiungi un tag meta-data per disattivare la raccolta automatica:

   <meta-data
       android:name="firebase_crashlytics_collection_enabled"
       android:value="false" />
   

2. Attiva la raccolta per utenti selezionati richiamando i dati di Crashlytics l'override della raccolta in fase di runtime. Il valore di override persiste per tutti i lanci della tua app in modo che Crashlytics possa raccogliere automaticamente i report. Per disattivare dei report automatici sugli arresti anomali, passa false come valore di override. Se impostato su false, il nuovo valore non viene applicato fino alla successiva esecuzione dell'app.

   Kotlin+KTX

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Nota: quando la raccolta dei dati è disattivata, Crashlytics memorizza le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene successivamente attivata, le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per nell'elaborazione del linguaggio naturale.

Gestire i dati di Insight sugli arresti anomali

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le analisi dello stack anonimizzate con quelle di altre app Firebase e ti informano se il problema fa parte di una tendenza più ampia. Per molti problemi, gli Approfondimenti sugli arresti anomali forniscono persino risorse per aiutarti a eseguire il debug dell'arresto anomalo.

Crash Insights utilizza dati aggregati sugli arresti anomali per identificare tendenze comuni di stabilità. Se preferisci non condividere i dati della tua app, puoi disattivare Crash Insights dal menu Approfondimenti sugli arresti anomali nella parte superiore dell'elenco dei problemi Crashlytics nella console Firebase.

Nota: la disattivazione della condivisione dei dati rimuove anche gli approfondimenti sui problemi. L'applicazione delle modifiche può richiedere fino a 24 ore.