Personalizzare i report sugli arresti anomali per Android

Seleziona la piattaforma: iOS+ Android Flutter Unity


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

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 Firebase console.

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

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

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 chiamando la chiave 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 coppie chiave-valore in blocco passando un'istanza di CustomKeysAndValues al metodo dell'istanza setCustomKeys:

Kotlin

Per Kotlin, la funzionalità esistente è più semplice rispetto all'utilizzo del builder 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 degli eventi che hanno portato a un arresto anomalo, puoi aggiungere log Crashlytics personalizzati alla tua app. Crashlytics associa i log ai dati sugli arresti anomali e li visualizza nella pagina Crashlytics della Firebase console, nella scheda Log.

Utilizza 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 in modo anonimo gli utenti nei report sugli arresti anomali.

Per aggiungere ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore sottoposto 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. La cancellazione di un identificatore utente non comporta la rimozione dei record Crashlytics 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 di NDK

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

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

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

Includere 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à di sicurezza delle app.

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

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

Puoi ottenere i report sulla memoria GWP-ASan se abiliti esplicitamente GWP-ASan nella tua app e utilizzi l'SDK Crashlytics per NDK v18.3.6+ (Firebase BoM v31.3.0+). Puoi testare la configurazione di GWP-ASan utilizzando il codice nativo di esempio nella documentazione di Android.

Segnalare eccezioni non irreversibili

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

Utilizza il metodo recordException per registrare le eccezioni non irreversibili 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
}

Inoltre, puoi anche allegare chiavi personalizzate all'eccezione non irreversibile specifica. Ad esempio:

Kotlin 

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e) {
        key("string key", "string value")
        key("boolean key", true)
        key("float key", Float.MAX_VALUE)
    }
    // handle your exception here
}

Java 

try {
    methodThatThrows();
} catch (Exception e) {
    CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
            .putString("string key", "string value")
            .putBoolean("boolean key", true)
            .putFloat("float key", Float.MAX_VALUE)
            .build();
    FirebaseCrashlytics.getInstance().recordException(e, keysAndValues);
    // handle your exception here
}

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

Ottenere i log dei breadcrumb

I log dei breadcrumb ti consentono di comprendere meglio le interazioni che un utente ha avuto con la tua app prima di un evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utili quando tenti di riprodurre ed eseguire il debug di un problema.

I log dei 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 dei breadcrumb vengono automaticamente inclusi nei dati di un evento nella scheda Log quando visualizzi i dettagli di un problema.

L'Analytics SDK 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 tutti gli eventi personalizzati che registri manualmente nella sessione dell'utente, inclusi i dati dei parametri dell'evento. Questi dati possono aiutare a mostrare una serie di azioni utente che hanno portato a un evento di arresto anomalo, non irreversibile o ANR.

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

Attivare la segnalazione con consenso esplicito

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app. Per dare agli utenti un maggiore controllo sui dati che inviano, puoi attivare la segnalazione con consenso esplicito disattivando la segnalazione automatica 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 gli utenti selezionati chiamando l'Crashlytics override della raccolta dati in fase di runtime. Il valore di override persiste in tutti gli avvii successivi dell'app, in modo che Crashlytics possa raccogliere automaticamente i report per l'utente.

    Kotlin 

    Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

    Java 

    FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

    Se l'utente in un secondo momento disattiva la raccolta dei dati, puoi passare false come valore di override, che verrà applicato al successivo avvio dell'app e persisterà in tutti gli avvii successivi per l'utente.

Gestire i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando le analisi dello stack anonime con quelle di altre app Firebase e comunicandoti 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 comuni di stabilità. Se preferisci non condividere i dati della tua app, puoi disattivare Crash Insights dal menu Crash Insights nella parte superiore dell'elenco dei problemi Crashlytics nella Firebase console.

Passaggi successivi