Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unity

Nella dashboard Crashlytics, puoi fare clic su un problema per visualizzare un report dettagliato sugli eventi. Puoi personalizzare questi report per comprendere meglio cosa succede nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

• Strumenta 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 l'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.

• Disattiva i report automatici sugli arresti anomali e attiva 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 Crashlytics, puoi cercare i problemi che corrispondono a una chiave personalizzata.

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

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Una volta raggiunta 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

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 richiamandola e impostandola su un valore diverso. Ad esempio:

Kotlin

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

Per Kotlin, la funzionalità esistente è più semplice dell'utilizzo del compilatore 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 avere un contesto più ampio sugli eventi che precedono un arresto anomalo, puoi aggiungere alla tua app log Crashlytics personalizzati. Crashlytics associa i log ai dati sugli arresti anomali e li mostra nella pagina Crashlytics della 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 precedenti quando i log di una sessione superano questo limite.

Usa log per individuare i problemi. Ad esempio:

Kotlin

Firebase.crashlytics.log("message")

Java

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

Impostare gli identificatori utente

Per diagnosticare un problema, spesso è utile sapere quali utenti hanno riscontrato un determinato arresto anomalo. Crashlytics include un modo per identificare anonimamente gli utenti nei report sugli arresti anomali.

Per aggiungere gli ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore sottoposta ad hashing:

Kotlin

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. L'eliminazione di un identificatore utente non comporta la rimozione dei recordCrashlytics esistenti. Se devi eliminare i record associati a un ID utente, contatta l'assistenza Firebase.

(Solo Android NDK) Aggiungere metadati ai report sugli arresti anomali 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 i 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 ottenere report sulla memoria di GWP-ASan se attivi esplicitamente GWP-ASan nella tua app e utilizzi l'SDK Crashlytics per NDK v18.3.6 o versioni successive (Firebase BoM v31.3.0 o versioni successive). Puoi testare la configurazione di GWP-ASan utilizzando il codice nativo di esempio nella documentazione di Android.

Segnalare 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 la tua app genera più di otto eccezioni, quelle precedenti andranno perse.

Utilizza il metodo recordException per registrare eccezioni non fatali nei blocchi catch della tua app. Ad esempio:

Kotlin

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 dei valori può comportare diversi problemi e potrebbe causare la limitazione da parte di Crashlytics degli errori di generazione di report nella tua app.

Tutte le eccezioni registrate vengono visualizzate come problemi non fatali nella console Firebase. Il riepilogo del problema contiene tutte le informazioni sullo stato che normalmente ricevi dagli arresti anomali, oltre alle suddivisioni 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.

Visualizzare i log dei breadcrumb

I log dei breadcrumb ti consentono di comprendere meglio le interazioni di un utente con la tua app che hanno portato a un arresto anomalo, a un evento non irreversibile o ANR. Questi log possono essere utili per provare a riprodurre e risolvere un problema.

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 di schermate visualizzate prima dell'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 compilati anche con eventuali eventi personalizzati registrati manualmente all'interno della sessione dell'utente, 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 Google Analytics, che includono i dati che compilano i log dei breadcrumb.

Attivare i report di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app. Per consentire agli utenti di avere maggiore controllo sui dati che inviano, puoi attivare i report per i quali è necessario l'attivazione disattivando i report automatici e inviando i dati a Crashlytics solo quando scegli di farlo 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 chiamando l'override della raccolta dei dati Crashlytics in fase di esecuzione. Il valore dell'override persiste per tutti i lanci della tua app, in modo che Crashlytics possa raccogliere automaticamente i report. Per disattivare i 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

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Nota: se disattivi i report automatici, tieni presente quanto segue:

• Quando la raccolta dei dati è disattivata per un utente, Crashlytics memorizza le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene attivata successivamente, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.
• Quando attivi i report di attivazione, le informazioni sugli arresti anomali possono essere raccolte solo dagli utenti che hanno attivato esplicitamente la raccolta dei dati. Di conseguenza, l'accuratezza delle metriche relative agli arresti anomali (ad esempio utenti e sessioni prive di arresti anomali) sarà interessata, poiché Crashlytics dispone solo delle informazioni sugli arresti anomali di questi utenti che hanno attivato la funzionalità (anziché di tutti i tuoi utenti). Ciò significa che le metriche senza arresti anomali potrebbero essere meno affidabili e meno rappresentative della stabilità complessiva della tua app.

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.

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

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