Questa guida descrive come personalizzare i rapporti sugli arresti anomali utilizzando le API di Crashlytics. Per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali nativi della piattaforma per tutti gli utenti della tua app (puoi anche disattivare i rapporti automatici sugli arresti anomali e abilitare invece i rapporti opt-in per i tuoi utenti). Crashlytics fornisce cinque meccanismi di registrazione pronti all'uso: chiavi personalizzate , registri personalizzati , identificatori utente , eccezioni rilevate e non rilevate.
Per le app Flutter, i report fatali 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 eccezioni non rilevate
Puoi rilevare automaticamente tutti gli errori "irreversibili" generati all'interno del framework Flutter eseguendo l'override di FlutterError.onError con FirebaseCrashlytics.instance.recordFlutterFatalError . In alternativa, per rilevare anche le eccezioni "non fatali", eseguire 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 tali 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 della tua app, Crashlytics ti consente di registrare le eccezioni non irreversibili e di inviartele la prossima volta che viene segnalato un evento irreversibile o al riavvio dell'app.
Usa il metodo recordError per registrare le eccezioni non irreversibili nei blocchi catch della tua app. Per 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 che è possibile utilizzando la proprietà delle 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 irreversibili nella console di Firebase. Il riepilogo del problema contiene tutte le informazioni sullo stato che normalmente si ottengono dagli arresti anomali, insieme ai guasti 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 dei tuoi utenti, Crashlytics limiterà la velocità del numero di rapporti inviati dal dispositivo, se necessario.
Aggiungi chiavi personalizzate
Le chiavi personalizzate ti aiutano a ottenere lo stato specifico della tua app che porta a un arresto anomalo. Puoi associare coppie chiave/valore arbitrarie ai rapporti sugli arresti anomali, quindi utilizzare le chiavi personalizzate per cercare e filtrare i rapporti 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 (sottoscheda Chiavi ) e persino filtrare gli eventi in base alle chiavi personalizzate (menu Filtro nella parte superiore della pagina).
Utilizzare 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);
Aggiungi messaggi di log personalizzati
Per avere più contesto per gli eventi che hanno portato a un arresto anomalo, puoi aggiungere log personalizzati di Crashlytics alla tua app. Crashlytics associa i log ai dati sugli arresti anomali e li visualizza nella console di Firebase , nella scheda Registri di Crashlytics.
Usa il log per aiutare a individuare i problemi. Per esempio:
FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");
Imposta identificatori utente
Per diagnosticare un problema, spesso è utile sapere quale dei tuoi utenti ha riscontrato un determinato arresto anomalo. Crashlytics include un modo per identificare in modo anonimo gli utenti nei rapporti sugli arresti anomali.
Per aggiungere ID utente ai rapporti, assegna a ogni utente un identificatore univoco sotto forma di numero ID, token o valore con hash:
FirebaseCrashlytics.instance.setUserIdentifier("12345");
Se è necessario cancellare un identificatore utente dopo averlo impostato, reimpostare il valore su una stringa vuota. La cancellazione di un identificatore utente non rimuove i record Crashlytics esistenti. Se devi eliminare i record associati a un ID utente, contatta l'assistenza di Firebase .
Abilita i rapporti opt-in
Per impostazione predefinita, Crashlytics raccoglie automaticamente rapporti sugli arresti anomali per tutti gli utenti della tua app. Per offrire agli utenti un maggiore controllo sui dati che inviano, puoi attivare i rapporti attivati disattivando i rapporti automatici e inviando i dati a Crashlytics solo quando scegli di farlo nel tuo codice:
Disattiva la raccolta automatica in modo nativo:
Piattaforme Apple
Aggiungi una nuova chiave al tuo file
Info.plist:- Chiave:
FirebaseCrashlyticsCollectionEnabled - Valore:
false
Androide
Nel blocco
applicationdel fileAndroidManifest.xml, aggiungi un tag dimeta-dataper disattivare la raccolta automatica:<meta-data android:name="firebase_crashlytics_collection_enabled" android:value="false" />- Chiave:
Abilita la raccolta per utenti selezionati chiamando l'override della raccolta dati di Crashlytics in fase di esecuzione.
Il valore di override persiste tra gli avvii della tua app in modo che Crashlytics possa raccogliere automaticamente i rapporti. Per disattivare la segnalazione automatica degli arresti anomali, passare
falsecome valore di sostituzione. Se impostato sufalse, il nuovo valore non si applica fino alla successiva esecuzione dell'app.FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
Gestisci i dati di Crash Insights
Crash Insights ti aiuta a risolvere i problemi confrontando le tue tracce dello stack anonime con le tracce di altre app Firebase e facendoti sapere 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 aggregati sugli arresti anomali per identificare le tendenze di stabilità comuni. 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 di Firebase .