Personalizzare i report sugli arresti anomali per Flutter

Seleziona la piattaforma: iOS+ Android Flutter Unity


Puoi fare clic su un problema e visualizzare un report dettagliato sugli eventi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase. 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 le eccezioni non rilevate

Puoi rilevare automaticamente tutti gli errori "fatali" 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'oggetto Isolate corrente:

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

Segnala le eccezioni rilevate

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

Utilizza il metodo recordError per registrare le eccezioni non fatali 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, il 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 fatali nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase. Il riepilogo del problema contiene tutte le informazioni sullo stato che normalmente ricevi dagli arresti anomali, oltre 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 dell'app. Per ridurre il traffico di rete degli utenti, Crashlytics limiterà la frequenza dei 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 dashboard DevOps e coinvolgimento > Crashlytics della console Firebase.

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

  • Quando esamini un problema specifico nella dashboard, 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).

Utilizza il metodo dell'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 mostra nella scheda Log quando visualizzi i dettagli di un problema (visualizza tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase).

Utilizza log per individuare i problemi. Ad esempio:

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

Imposta gli identificatori dell'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 hash:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Se devi cancellare un identificatore dell'utente dopo averlo impostato, reimposta il valore su una stringa vuota. La cancellazione di un identificatore dell'utente non comporta la rimozione dei record Crashlytics esistenti. 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 di un utente con la tua app che hanno portato a un evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utili per riprodurre un problema ed eseguirne il debug.

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 inclusi automaticamente nei dati di un evento nella scheda Log quando visualizzi i dettagli di un problema (visualizza tutti i problemi nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase).

L'SDK Analytics registra automaticamente l'evento screen_view, consentendo 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 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 di Google Analytics, che includono i dati che compilano i log dei breadcrumb.

Attiva i report di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi attivare i report con attivazione disattivando i report automatici 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 utenti selezionati chiamando l'override della raccolta dei dati Crashlytics in fase di runtime. Il valore di override viene mantenuto in tutti i lanci 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 da parte dell'utente e persisterà in tutti gli avvii successivi per quell'utente.

Gestisci i dati di Crash Insights

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le tue analisi dello stack anonimizzate con quelle di altre app Firebase e informandoti se il tuo problema fa parte di una tendenza più ampia. Per molti problemi, gli insight sugli arresti anomali forniscono 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 nella dashboard DevOps e coinvolgimento > Crashlytics della console Firebase.

Passaggi successivi