Personalizzare i report sugli arresti anomali per Flutter

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.

Segnala eccezioni

Segnala eccezioni non rilevate

Puoi rilevare automaticamente tutti gli errori "irreversibili" generati all'interno del framework Flutter eseguendo l'override di FlutterError.onError con FirebaseCrashlytics.instance.recordFlutterFatalError. In alternativa, per rilevare anche le eccezioni "non irreversibili", esegui l'override di 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 questi 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 al di fuori di Flutter

Per rilevare gli errori che si verificano al di fuori del contesto Flutter, installa un listener di errori sull'attuale Isolate:

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

Segnala eccezioni rilevate

Oltre a segnalare automaticamente gli arresti anomali della tua app, Crashlytics ti consente di registrare le eccezioni non irreversibili e di inviarle la volta successiva che viene segnalato un evento irreversibile o al riavvio dell'app.

Utilizza il metodo recordError per registrare le eccezioni non irreversibili nei blocchi catch della tua app. Ad 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 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 Firebase console. Il riepilogo dei problemi 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 degli utenti, Crashlytics limiterà la frequenza del numero di report inviati dal dispositivo, se necessario.

Aggiungi 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 di istanza setCustomKey per impostare le 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 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 Firebase console, nella scheda Crashlytics Log.

Utilizza log per individuare i problemi. Ad esempio:

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

Imposta 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 gli ID utente ai report, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore sottoposto ad hashing:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

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 esistenti Crashlytics. Se devi eliminare i record associati a un ID utente, contatta l'assistenza Firebase.

Ottieni 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 cerchi 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 aiutarti 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.

Attiva 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. Disattiva la raccolta automatica in modo nativo:

    Piattaforme Apple

    Aggiungi una nuova chiave al file Info.plist:

    • Chiave: FirebaseCrashlyticsCollectionEnabled
    • Valore: false

    Android

    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 dei dati in fase di runtime. Il valore di override viene mantenuto in tutti gli avvii successivi dell'app, in modo che Crashlytics possa raccogliere automaticamente i report per l'utente.

    FirebaseCrashlytics.instance.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 verrà mantenuto in tutti gli avvii successivi per l'utente.

Gestisci 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 informandoti 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