Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unity

Nella dashboard Crashlytics, puoi fare clic su un problema e ottenere un report dettagliato sugli eventi. Puoi personalizzare questi report per comprendere meglio cosa succede nella tua app e le circostanze che circondano gli eventi segnalati a Crashlytics.

• Segnala le eccezioni non rilevate e le eccezioni rilevate a Crashlytics.

• Strumenta la tua app per registrare chiavi personalizzate, messaggi di log personalizzati e identificatori utente.

• Ricevi automaticamente i log di breadcrumb se la tua app utilizza l'SDK Firebase per Google Analytics. Questi log ti offrono visibilità sulle azioni degli utenti che hanno portato a un evento raccolto da Crashlytics nella tua app.

• Disattiva la segnalazione automatica degli arresti anomali e attiva la segnalazione con consenso per i tuoi utenti. Tieni presente che, per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali nativi della piattaforma per tutti gli utenti della tua app.

Nota: per le app Flutter, i report sugli errori irreversibili vengono inviati a Crashlytics in tempo reale senza che l'utente debba riavviare l'applicazione. I report non irreversibili vengono scritti su disco per essere inviati insieme al successivo report irreversibile o al riavvio dell'app.

Segnala le eccezioni non rilevate

Puoi rilevare automaticamente tutti gli errori "irreparabili" 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 dell'app, Crashlytics ti consente di registrare eccezioni non irreversibili e di inviartele la volta successiva che viene segnalato un evento irreversibile o al riavvio dell'app.

Nota :Crashlytics memorizza solo le otto eccezioni non fatali registrate più recenti. Se la tua app genera più di otto eccezioni, quelle più vecchie vengono perse. Questo conteggio viene reimpostato ogni volta che viene generata un'eccezione irreversibile, poiché ciò causa l'invio di un report a Crashlytics.

Utilizza il metodo recordError per registrare 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, cosa 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'],
);

Avviso: se vuoi includere un valore univoco (ad esempio un ID utente o un timestamp) nel messaggio di eccezione, utilizza una chiave personalizzata anziché aggiungere il valore direttamente nel messaggio di eccezione. L'aggiunta diretta di valori può comportare diversi problemi e potrebbe indurre Crashlytics a limitare gli errori dei report nella tua app.

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 degli utenti, Crashlytics limiterà la frequenza del numero di report inviati dal dispositivo, se necessario.

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

• Nella dashboard 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 ogni evento (scheda secondaria Chiavi) e persino filtrare gli eventi in base alle chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Una volta raggiunto questo limite, i valori aggiuntivi non vengono salvati. Ogni coppia chiave/valore può avere una dimensione massima di 1 kB.

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

Aggiungere messaggi di log personalizzati

Per avere più contesto sugli 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 console Firebase, nella scheda Crashlytics Log.

Nota: per evitare di rallentare l'app, Crashlytics limita i log a 64 kB ed elimina le voci di log meno recenti quando i log di una sessione superano questo limite.

Utilizza log per individuare i problemi. Ad esempio:

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

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 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. L'eliminazione di un identificatore utente non comporta la rimozione dei record Crashlyticsesistenti. Se devi eliminare i record associati a un ID utente, contatta l'assistenza Firebase.

Recuperare 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 si tenta di riprodurre ed eseguire il debug di un problema.

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

L'SDK Analytics registra automaticamente l'screen_view evento 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 breadcrumb screen_view contiene un parametro firebase_screen_class.

I log breadcrumb vengono compilati anche con eventuali eventi personalizzati che registri manualmente all'interno della sessione dell'utente, inclusi i dati dei parametri dell'evento. Questi dati possono contribuire a mostrare una serie di azioni dell'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, che includono i dati che compilano i log della breadcrumb.

Attivare i report di attivazione

Se attivi i report con consenso esplicito disattivando i report automatici, ridurrai l'accuratezza del conteggio degli eventi e delle metriche senza arresti anomali della tua app, che rifletteranno meno la stabilità complessiva dell'app. Scopri di più.

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 i report con consenso esplicito disattivando i report automatici e inviando i dati solo a Crashlytics quando scegli di farlo nel codice.

1. Disattivare 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'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 trasmettere false come valore di override, che verrà applicato al successivo avvio dell'app da parte dell'utente e verrà mantenuto per tutti gli avvii successivi.

Nota: quando la raccolta dei dati è disattivata per un utente, Crashlytics memorizzerà le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene attivata in un secondo momento, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.

Gestire i dati di Crash Insights

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le analisi dello stack anonimizzate 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 sugli arresti anomali aggregati 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.

Nota: la disattivazione della condivisione dei dati rimuove anche gli approfondimenti sui tuoi problemi. L'applicazione delle modifiche può richiedere fino a 24 ore.