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 ciò che accade nella tua app e le circostanze relative agli eventi segnalati a Crashlytics.

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

• Instrumenta 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 la classe 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 per impostazione predefinita, Crashlytics raccoglie automaticamente i report sugli arresti anomali nativi della piattaforma per tutti gli utenti della tua app.

di Gemini Advanced.

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.

Segnalare le eccezioni non rilevate

Puoi rilevare automaticamente tutti i messaggi "irreversibili" che vengono generati all'interno di Flutter eseguendo l'override di 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 individuare 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 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);

Segnala 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 meno recenti andranno perse. Questo conteggio viene reimpostato ogni volta che viene lanciata un'eccezione irreversibile, 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);

Puoi anche registrare ulteriori informazioni sull'errore, se 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 causa diversi problemi e Crashlytics potrebbe limitare gli errori nei report nell'app.

Queste eccezioni vengono visualizzate come problemi non irreversibili nella console Firebase. La il riepilogo dei problemi contiene tutte le informazioni sullo stato solitamente ricevute dagli arresti anomali, oltre alle suddivisioni per versione e dispositivo hardware.

Crashlytics elabora le eccezioni su un thread dedicato in background per minimizzare l'impatto sulle prestazioni della tua app. Ridurre la rete degli utenti traffico, Crashlytics limiterà la frequenza di invio di segnalazioni 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 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).

di Gemini Advanced.

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ò essere a 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 darti maggiore contesto sugli eventi che hanno portato a un arresto anomalo, puoi aggiungere log Crashlytics personalizzati nella tua app. Crashlytics associa i log con i dati sugli arresti anomali e li visualizza nel Console Firebase, nella scheda Log di Crashlytics.

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 utente

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.

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 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 anche compilati con qualsiasi eventi personalizzati registrati manualmente nell'interfaccia utente sessione, 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 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 relativi a tutti i tuoi utenti dell'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. 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 di override rimane per tutti i lanci dell'app, quindi Crashlytics possono 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 verranno applicate fino alla successiva esecuzione dell'app.

   FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
   

di Gemini Advanced.

Nota: se la raccolta dei dati è disattivata, Crashlytics archivierà gli arresti anomali informazioni a livello locale sul dispositivo. Se la raccolta dei dati viene successivamente attivata, le informazioni sugli arresti anomali memorizzate sul dispositivo verranno inviate a Crashlytics per nell'elaborazione del linguaggio naturale.

Gestisci i dati di Crash Insights

Crash Insights ti aiuta a risolvere i problemi confrontando il tuo stack anonimo da altre app Firebase e ti comunica se il problema è parte di una tendenza più ampia. Per molti problemi, Crash Insights fornisce anche per 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. Le modifiche potrebbero possono trascorrere fino a 24 ore prima che le modifiche diventino effettive.