Personalizza i rapporti sugli arresti anomali di Firebase Crashlytics

Nella dashboard di Crashlytics, puoi fare clic su un problema e ottenere un rapporto dettagliato sull'evento. Puoi personalizzare questi report per aiutarti a comprendere meglio cosa sta succedendo nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

Segnala eccezioni non rilevate

Puoi rilevare automaticamente tutti gli errori "fatali" generati all'interno del framework Flutter eseguendo l'override FlutterError.onError con FirebaseCrashlytics.instance.recordFlutterFatalError . In alternativa, per rilevare anche eccezioni "non fatali", sovrascrivi FlutterError.onError con FirebaseCrashlytics.instance.recordFlutterError :

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();
  bool weWantFatalErrorRecording = true;
  FlutterError.onError = (errorDetails) {
    if(weWantFatalErrorRecording){
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    } else {
      FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
    }
  };

  runApp(MyApp());
}

Errori asincroni

Gli errori asincroni non vengono rilevati dal framework Flutter:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Per rilevare tali errori, puoi utilizzare il gestore PlatformDispatcher.instance.onError :

Future<void> main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await Firebase.initializeApp();
    FlutterError.onError = (errorDetails) {
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    };
    // Pass all uncaught asynchronous errors that aren't handled by the Flutter framework to Crashlytics
    PlatformDispatcher.instance.onError = (error, stack) {
      FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
      return true;
    };
    runApp(MyApp());

}

Errori esterni a Flutter

Per rilevare gli errori che si verificano al di fuori del contesto Flutter, installa un ascoltatore di errori Isolate corrente:

Isolate.current.addErrorListener(RawReceivePort((pair) async {
  final List<dynamic> errorAndStacktrace = pair;
  await FirebaseCrashlytics.instance.recordError(
    errorAndStacktrace.first,
    errorAndStacktrace.last,
    fatal: true,
  );
}).sendPort);

Il rapporto ha rilevato eccezioni

Oltre a segnalare automaticamente gli arresti anomali della tua app, Crashlytics ti consente di registrare eccezioni non fatali e te le invia la prossima volta che viene segnalato un evento fatale o al riavvio dell'app.

Utilizza il metodo recordError per registrare eccezioni non irreversibili nei blocchi catch della tua app. Per esempio:

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error'
);

// Or you can use:
await FirebaseCrashlytics.instance.recordFlutterError(errorDetails);

Potresti anche voler registrare ulteriori informazioni sull'errore che è possibile utilizzando la proprietà information :

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error',
  information: ['further diagnostic information about the error', 'version 2.0'],
);

Queste eccezioni 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 alle suddivisioni per versione 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 dei tuoi utenti, Crashlytics limiterà la velocità del numero di report inviati dal dispositivo, se necessario.

Aggiungi chiavi personalizzate

Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app che ha portato 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 a ciascun evento (sottoscheda 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 coppie chiave/valore. Ecco alcuni esempi:

// Set a key to a string.
FirebaseCrashlytics.instance.setCustomKey('str_key', 'hello');

// Set a key to a boolean.
FirebaseCrashlytics.instance.setCustomKey("bool_key", true);

// Set a key to an int.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1);

// Set a key to a long.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1L);

// Set a key to a float.
FirebaseCrashlytics.instance.setCustomKey("float_key", 1.0f);

// Set a key to a double.
FirebaseCrashlytics.instance.setCustomKey("double_key", 1.0);

Aggiungi messaggi di registro personalizzati

Per avere più contesto per gli eventi che portano 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 console Firebase , nella scheda Log di Crashlytics.

Utilizza log per individuare i problemi. Per esempio:

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Imposta gli 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 tuoi rapporti, assegna a ciascun utente un identificatore univoco sotto forma di numero ID, token o valore hash:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Se mai fosse 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 Firebase .

Ottieni i log breadcrumb

I log breadcrumb ti offrono una migliore comprensione delle interazioni che un utente ha avuto con la tua app prima di un arresto anomalo, di un evento non fatale o di un evento ANR. Questi log possono essere utili quando si tenta di riprodurre ed eseguire il debug di un problema.

I log breadcrumb sono forniti da Google Analytics, quindi per ottenere i log breadcrumb devi abilitare Google Analytics per il tuo progetto Firebase e aggiungere l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i registri breadcrumb vengono automaticamente inclusi con i dati di un evento nella scheda Registri quando visualizzi i dettagli di un problema.

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

I log breadcrumb vengono inoltre popolati con eventuali eventi personalizzati registrati manualmente nella sessione dell'utente, inclusi i dati dei parametri dell'evento. Questi dati possono aiutare a mostrare una serie di azioni dell'utente che portano a un arresto anomalo, a un evento non fatale 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 breadcrumb.

Abilita il reporting di attivazione

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 il reporting disattivando il reporting automatico e inviando i dati a Crashlytics solo quando lo scegli nel tuo codice:

  1. Disattiva la raccolta automatica in modo nativo:

    Piattaforme Apple

    Aggiungi una nuova chiave al tuo file Info.plist :

    • Chiave: FirebaseCrashlyticsCollectionEnabled
    • Valore: false

    Androide

    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 i lanci della tua app in modo che Crashlytics possa raccogliere automaticamente i report. 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.

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);

Gestisci i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando le tue tracce di 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 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 di Crashlytics nella console Firebase .