Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS+ Android Flutter Unity

Nella dashboard Crashlytics, puoi fare clic su un problema per visualizzare un report dettagliato sugli eventi. Puoi personalizzare questi report per comprendere meglio cosa succede nella tua app e le circostanze relative agli 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 dei breadcrumb se la tua app utilizza l'SDK Firebase per Google Analytics. Questi log ti consentono di monitorare le azioni degli utenti che precedono un evento raccolto da Crashlytics nella tua app.

• Disattiva i report automatici sugli arresti anomali e attiva i report di attivazione 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 critici vengono inviati a Crashlytics in tempo reale senza che l'utente debba riavviare l'applicazione. I report non fatali vengono scritti su disco per essere inviati insieme al successivo report irreversibile o al riavvio dell'app.

Segnalare le eccezioni non rilevate

Puoi rilevare automaticamente tutti gli errori "fatali" generati all'interno del framework Flutter sostituendo FlutterError.onError con FirebaseCrashlytics.instance.recordFlutterFatalError. In alternativa, per rilevare anche le eccezioni "non fatali", sostituisci 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 l'handler 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 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);

Segnalare le eccezioni rilevate

Oltre a segnalare automaticamente gli arresti anomali dell'app, Crashlytics consente di registrare le eccezioni non irreversibili e di inviarle la volta successiva che viene segnalato un evento irreversibile o quando l'app si riavvia.

Nota: Crashlytics memorizza solo le otto eccezioni non fatali registrate più recenti. Se l'app genera più di otto eccezioni, quelle precedenti vengono perse. Questo conteggio viene reimpostato ogni volta che viene lanciata un'eccezione fatale, poiché provoca l'invio di un report a Crashlytics.

Utilizza il metodo recordError per registrare le eccezioni non fatali nei blocchi di blocco 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);

Ti consigliamo inoltre di 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 dei valori può causare diversi problemi e potrebbe portare Crashlytics a limitare gli errori di generazione dei report nella tua app.

Queste eccezioni vengono visualizzate come problemi non fatali nella console Firebase. Il Riepilogo dei problemi contiene tutte le informazioni sullo stato che normalmente ricevi dagli arresti anomali, nonché le suddivisioni per versione e dispositivo hardware.

Crashlytics elabora le eccezioni in un thread in background dedicato per minimizzare l'impatto sul rendimento della tua app. Per ridurre il traffico di rete degli utenti, Crashlytics imposterà una limitazione di frequenza per il 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 corrispondenti a una chiave personalizzata.

• Quando esamini un problema specifico nella console, puoi visualizzare le chiavi personalizzate associate per 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 raggiunta questa soglia, i valori aggiuntivi non vengono salvati. Ogni coppia chiave/valore può avere una dimensione massima di 1 kB.

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

Aggiungere messaggi di log personalizzati

Per avere un contesto più ampio sugli eventi che precedono un arresto anomalo, puoi aggiungere alla tua app log Crashlytics personalizzati. Crashlytics associa i log ai dati sugli arresti anomali e li mostra 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 precedenti quando i log di una sessione superano questo limite.

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

Visualizzare 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 arresto anomalo, a un evento non irreversibile o ANR. Questi log possono essere utili per provare a riprodurre e risolvere 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 con i dati di un evento nella scheda Log quando visualizzi i dettagli di un problema.

L'SDK Analytics 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 eventuali eventi personalizzati registrati manualmente all'interno della sessione dell'utente, inclusi i dati dei parametri dell'evento. Questi dati possono essere utili per mostrare una serie di azioni utente che hanno portato a un arresto anomalo, a un evento 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 dei breadcrumb.

Attivare i report di attivazione

Per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali per tutti gli utenti della tua app. Per consentire agli utenti di avere maggiore controllo sui dati che inviano, puoi attivare i report per i quali è necessario l'attivazione disattivando i report automatici e inviando i dati a Crashlytics solo 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 utenti selezionati chiamando l'override della raccolta dei dati Crashlytics in fase di esecuzione.

   Il valore dell'override persiste nei vari lanci dell'app, in modo che Crashlytics puoi raccogliere automaticamente i report. Per disattivare i report automatici sugli arresti anomali, passa false come valore di override. Se impostato su false, il nuovo valore non viene applicato fino alla successiva esecuzione dell'app.

   FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
   

Nota: se disattivi i report automatici, tieni presente quanto segue:

• Quando la raccolta dei dati è disattivata per un utente, Crashlytics memorizza le informazioni sugli arresti anomali localmente sul dispositivo. Se la raccolta dei dati viene attivata successivamente, tutte le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per l'elaborazione.
• Quando attivi i report di attivazione, le informazioni sugli arresti anomali possono essere raccolte solo dagli utenti che hanno attivato esplicitamente la raccolta dei dati. Di conseguenza, l'accuratezza delle metriche relative agli arresti anomali (ad esempio utenti e sessioni prive di arresti anomali) sarà interessata, poiché Crashlytics dispone solo delle informazioni sugli arresti anomali di questi utenti che hanno attivato la funzionalità (anziché di tutti i tuoi utenti). Ciò significa che le metriche relative all'assenza di arresti anomali potrebbero essere meno affidabili e meno rappresentative della stabilità complessiva dell'app.

Gestire i dati di Insight sugli arresti anomali

Gli insight sugli arresti anomali ti aiutano a risolvere i problemi confrontando le analisi dello stack anonimizzate con quelle di altre app Firebase e ti informano se il problema fa parte di una tendenza più ampia. Per molti problemi, gli Approfondimenti sugli arresti anomali forniscono persino risorse per aiutarti a eseguire il debug dell'arresto anomalo.

Arresti anomali 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 gli Approfondimenti sugli arresti anomali dal menu Approfondimenti sugli arresti anomali nella parte superiore dell'elenco dei problemi Crashlytics nella console Firebase.

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