Ten krótki przewodnik zawiera instrukcje konfigurowania w aplikacji Firebase Crashlytics za pomocą wtyczki Flutter Crashlytics, aby otrzymywać kompleksowe raporty o awariach w konsoli Firebase.
Konfigurowanie Crashlytics wymaga użycia narzędzia wiersza poleceń i IDE. Aby dokończyć konfigurację, musisz wymusić wyjątek testowy, aby wysłać pierwszy raport o awarii do Firebase.
Zanim zaczniesz
Jeśli jeszcze tego nie zrobiono, skonfiguruj i inicjuj Firebase w projekcie Flutter.
Zalecane: aby automatycznie otrzymywać logi menu nawigacyjnego umożliwiające zrozumienie działań użytkowników, które prowadzą do awarii, zdarzeń niekrytycznych lub błędów ANR, musisz włączyć Google Analytics w projekcie Firebase.
Jeśli w istniejącym projekcie Firebase nie włączono Google Analytics, możesz włączyć Google Analytics na karcie Integracje w sekcji
w konsoli > Ustawienia projektuFirebase. Jeśli tworzysz nowy projekt Firebase, włącz Google Analytics w trakcie procesu tworzenia projektu.
Pamiętaj, że ścieżki przewijania są dostępne na wszystkich obsługiwanych przez Crashlytics platformach z Androidem i Apple (z wyjątkiem watchOS).
Krok 1. Dodaj Crashlytics do projektu Flutter
W katalogu głównym projektu Flutter uruchom to polecenie, aby zainstalować wtyczkę Flutter dla Crashlytics.
Aby korzystać z logów menu nawigacyjnego, dodaj też do swojej aplikacji wtyczkę Flutter dla Google Analytics. Sprawdź, czy w projekcie Firebase jest włączona usługa Google Analytics.
flutter pub add firebase_crashlytics && flutter pub add firebase_analytics
W katalogu głównym projektu Flutter uruchom to polecenie:
flutterfire configure
Uruchomienie tego polecenia zapewnia aktualność konfiguracji Firebase w aplikacji Flutter. W przypadku Androida doda też do aplikacji wymagany wtyczek Crashlytics Gradle.
Po zakończeniu odbuduj projekt Flutter:
flutter run
(Opcjonalnie) Jeśli Twój projekt Flutter używa flagi
--split-debug-info
(i opcjonalnie także--obfuscate
), musisz wykonać dodatkowe czynności, by wyświetlić czytelne zrzuty stosu aplikacji.Platformy Apple: sprawdź, czy Twój projekt korzysta z zalecanej konfiguracji wersji (Flutter 3.12.0 lub nowszej i Crashlytics wtyczka Flutter 3.3.4 lub nowsza), aby projekt mógł automatycznie generować i przesyłać symbole Flutter (pliki dSYM) do Crashlytics.
Android: użyj interfejsu wiersza poleceń Firebase (w wersji 11.9.0 lub nowszej), aby przesłać symbole debugowania Flutter. Musisz przesłać symbole debugowania przed zgłoszeniem awarii w wersji kompilacji zaciemnionego kodu.
W katalogu głównym projektu Flutter uruchom to polecenie:
firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols
FIREBASE_APP_ID: identyfikator aplikacji Firebase na Androida (nie nazwa pakietu)
Przykładowy identyfikator aplikacji Firebase na Androida:1:567383003300:android:17104a2ced0c9b9b
PATH/TO/symbols
: ten sam katalog, który przekazujesz parametrowi--split-debug-info
podczas kompilowania aplikacji.
Krok 2. Skonfiguruj moduły obsługi awarii
Możesz automatycznie przechwytywać wszystkie błędy występujące w ramach frameworka Fluttera, zastępując FlutterError.onError
wartością FirebaseCrashlytics.instance.recordFlutterFatalError
:
void main() async {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp();
// Pass all uncaught "fatal" errors from the framework to Crashlytics
FlutterError.onError = FirebaseCrashlytics.instance.recordFlutterFatalError;
runApp(MyApp());
}
Aby wykrywać błędy asynchroniczne, których nie obsługuje platforma Flutter, użyj:
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());
}
Przykłady postępowania z innymi typami błędów znajdziesz w artykule Dostosowywanie raportów o awariach.
Krok 3. Wymuś testowy błąd krytyczny, aby zakończyć konfigurację
Aby dokończyć konfigurowanie usługi Crashlytics i wyświetlić początkowe dane w panelu Crashlytics w konsoli Firebase, musisz wymusić odrzucenie wyjątku testowego.
Dodaj do aplikacji kod, który spowoduje wyjątek testowy.
Jeśli dodasz moduł obsługi błędów, który wywołuje
FirebaseCrashlytics.instance.recordError(error, stack, fatal: true)
doZone
najwyższego poziomu, możesz użyć tego kodu, by dodać do aplikacji przycisk, który po jego naciśnięciu spowoduje zgłoszenie wyjątku testowego:TextButton( onPressed: () => throw Exception(), child: const Text("Throw Test Exception"), ),
Kompilowanie i uruchamianie aplikacji.
Wymuś wyjątek testowy, aby wysłać pierwszy raport aplikacji:
Otwórz aplikację na urządzeniu testowym lub w emulatorze.
W aplikacji kliknij przycisk wyjątku testowego, który został dodany za pomocą kodu powyżej.
Aby zobaczyć testowy błąd krytyczny, otwórz panel Crashlytics w konsoli Firebase.
Jeśli po 5 minutach od odświeżenia konsoli nadal nie widzisz testowego błędu, włącz debugowanie, aby sprawdzić, czy aplikacja wysyła raporty o błędach.
To wszystko. Crashlytics monitoruje teraz Twoją aplikację pod kątem awarii oraz błędów niekrytycznych i błędów ANR na Androidzie. Otwórz panel Crashlytics, aby wyświetlić wszystkie raporty i statystyki oraz je analizować.
Dalsze kroki
Dostosuj konfigurację raportów o awariach, dodając raporty o awariach, logi, klucze i opcje śledzenia dodatkowych błędów niekrytycznych.
Integracja z usługą Google Play pozwala filtrować raporty o awariach aplikacji na Androida według ścieżki Google Play bezpośrednio w panelu Crashlytics. Dzięki temu możesz lepiej skupić się na konkretnych wersjach na potrzeby panelu.
Wyświetlanie śladów stosu i statystyk awarii obok kodu za pomocą okna Statystyki jakości aplikacji w Android Studio (dostępne od wersji Electric Eel 2022.1.1).