Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unità

Questa guida descrive come personalizzare i rapporti sugli arresti anomali utilizzando l'SDK Firebase Crashlytics. Per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali per tutti gli utenti della tua app (puoi disattivare i rapporti automatici sugli arresti anomali e abilitare invece i rapporti opt-in per i tuoi utenti). Crashlytics fornisce quattro meccanismi di registrazione predefiniti: chiavi personalizzate , registri personalizzati , identificatori utente ed eccezioni rilevate .

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app che porta a un arresto anomalo. Puoi associare coppie chiave/valore arbitrarie ai rapporti sugli arresti anomali, quindi utilizzare le chiavi personalizzate per cercare e filtrare i rapporti 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 le chiavi personalizzate associate per ogni evento (sottoscheda Chiavi ) e persino filtrare gli eventi in base alle chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Utilizzare il metodo di istanza setCustomKey per impostare le coppie chiave/valore. Si noti che setCustomKey è sottoposto a overload per consentire al parametro value di accettare qualsiasi argomento primitivo o String . Ecco alcuni esempi:

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
}

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 */);

È inoltre possibile modificare il valore di una chiave esistente chiamando la chiave e impostandola su un valore diverso. Per esempio:

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

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

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

Aggiungi coppie chiave/valore in blocco passando un'istanza di CustomKeysAndValues ​​al metodo di istanza setCustomKeys :

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)
}

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);

Aggiungi messaggi di log personalizzati

Per avere più contesto per gli eventi che hanno portato a un arresto anomalo, puoi aggiungere log personalizzati di Crashlytics alla tua app. Crashlytics associa i log ai dati sugli arresti anomali e li visualizza nella pagina Crashlytics della console Firebase , nella scheda Log .

Usa log per aiutare a individuare i problemi. Per esempio:

Firebase.crashlytics.log("message")

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

Imposta identificatori utente

Per diagnosticare un problema, spesso è utile sapere quale dei tuoi utenti ha riscontrato un determinato arresto anomalo. Crashlytics include un modo per identificare in modo anonimo gli utenti nei rapporti sugli arresti anomali.

Per aggiungere ID utente ai rapporti, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore con hash:

Firebase.crashlytics.setUserId("user123456789")

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

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

(Solo Android NDK) Aggiungi metadati ai rapporti sugli arresti anomali di NDK

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

crashlytics.h è disponibile come libreria C++ di sola intestazione nel repository GitHub di Firebase Android SDK .

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

Segnala eccezioni non irreversibili

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

Usa il metodo recordException per registrare le eccezioni non irreversibili nei blocchi catch della tua app. Per esempio:

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

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

Tutte le eccezioni registrate vengono visualizzate come problemi non irreversibili nella console Firebase. Il riepilogo del problema contiene tutte le informazioni sullo stato che normalmente ottieni dagli arresti anomali, insieme ai guasti per versione di Android e dispositivo hardware.

Crashlytics elabora le eccezioni su un thread in background dedicato per ridurre al minimo l'impatto sulle prestazioni della tua app. Per ridurre il traffico di rete degli utenti, Crashlytics raggruppa le eccezioni registrate e le invia al successivo avvio dell'app.

Abilita i rapporti opt-in

Per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali per tutti gli utenti della tua app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi attivare i rapporti attivati ​​disattivando i rapporti automatici e inviando i dati a Crashlytics solo quando scegli di farlo nel tuo 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. Abilita la raccolta per utenti selezionati chiamando l'override della raccolta dati di Crashlytics in fase di esecuzione. Il valore di override persiste tra gli avvii della tua app in modo che Crashlytics possa raccogliere automaticamente i rapporti. Per disattivare la segnalazione automatica degli arresti anomali, passare false come valore di sostituzione. Se impostato su false , il nuovo valore non si applica fino alla successiva esecuzione dell'app.

   Kotlin+KTX

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Gestisci i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando le tue tracce dello stack anonime con le tracce di altre app Firebase e facendoti sapere se il tuo problema fa parte di una tendenza più ampia. Per molti problemi, Crash Insights fornisce anche risorse per aiutarti a eseguire il debug dell'arresto anomalo.

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