Personalizza i report sugli arresti anomali di Firebase Crashlytics

iOS e versioni successive Android Flusso Unità

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.

• Disattivare i report automatici sugli arresti anomali e abilitare 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 con errori irreversibili vengono inviati a Crashlytics in tempo reale senza che l'utente debba riavviare l'applicazione. I report non irreversibili sono vengono scritti su disco per essere inviati insieme al successivo report irreversibile o quando l'app si riavvia.

Segnala 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 i dati "non irreversibili" eccezioni, 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 errori che si verificano al di fuori del contesto Flutter, installa un errore listener 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 registri eccezioni non irreversibili e te le invia la prossima volta che o al riavvio dell'app.

Nota: Crashlytics memorizza solo gli ultimi otto eventi non irreversibili registrati eccezioni. Se l'app ne genera più di otto, le eccezioni precedenti vengono perse. Questo conteggio viene reimpostato ogni volta che viene generata un'eccezione irreversibile, poiché questo fa sì che venga generato da inviare all'indirizzo Crashlytics.

Utilizza il metodo recordError per registrare eccezioni non irreversibili nella risposta dell'app isolati. 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é aggiungendo il valore direttamente nel messaggio di eccezione. L'aggiunta diretta di valori causa diversi problemi e Crashlytics potrebbe limitare gli errori nei report nell'app.

Queste eccezioni vengono visualizzate come problemi non irreversibili 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 di Crashlytics, puoi cercare i problemi che corrispondono a una chiave personalizzata.

• Quando esamini un problema specifico nella console, puoi visualizzare chiavi personalizzate associate a ogni evento (scheda Chiavi) e persino filtrare gli eventi per chiavi personalizzate (menu Filtro nella parte superiore della pagina).

Nota: Crashlytics supporta un massimo di 64 coppie chiave/valore. Dopo aver raggiunto 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 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 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 meno recenti 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 degli utenti

Per diagnosticare un problema, spesso è utile sapere quali utenti hanno riscontrato a un determinato arresto anomalo. Crashlytics include un modo per identificare in modo anonimo gli utenti in i tuoi report sugli arresti anomali.

Per aggiungere gli ID utente ai report, assegna a ciascun utente un identificatore univoco nella di un numero ID, di un token o di un valore hash:

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 utente ID, contatta l'assistenza Firebase.

Recupera log dei breadcrumb

I log dei breadcrumb offrono una migliore comprensione delle interazioni di un utente ha avuto con la tua app e ha causato un evento di arresto anomalo, non irreversibile o ANR. Questi log possono essere utile quando si cerca di riprodurre un problema ed eseguirne il debug.

I log dei breadcrumb sono basati su Google Analytics, quindi per ottenere i log dei breadcrumb, necessario abilita Google Analytics per il tuo progetto Firebase aggiungi l'SDK Firebase per Google Analytics alla tua app. Una volta soddisfatti questi requisiti, i log dei breadcrumb vengono automaticamente inclusione dei 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 delle schermate visualizzate prima del di un evento di arresto anomalo, non irreversibile o ANR. Un log breadcrumb screen_view contiene un 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 di Google Analytics, che includono i dati che popolano 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 attiva la generazione di report disattivando la generazione di report automatici e inviando dati solo a Crashlytics quando scegli nel codice:

1. Per 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 richiamando i dati di Crashlytics l'override della raccolta in fase di runtime.

   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, trasmetti false come valore di override. Se impostato su false, il nuovo valore non verranno applicate fino alla successiva esecuzione dell'app.

   FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
   

Nota: se la raccolta dei dati è disattivata, Crashlytics archivierà gli arresti anomali informazioni a livello locale 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.

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.

Crash Insights utilizza dati aggregati sugli arresti anomali per identificare tendenze comuni di stabilità. Se preferisci non condividere i dati della tua app, puoi disattivare Crash Insights dal menu Approfondimenti sugli arresti anomali nella parte superiore dell'elenco dei problemi Crashlytics nella console Firebase.

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