Dostosuj raporty o awariach Firebase Crashlytics

iOS+ Android Flutter Unity

W tym przewodniku opisano, jak dostosować raporty o awariach za pomocą pakietu SDK Firebase Crashlytics. Domyślnie Crashlytics automatycznie zbiera raporty o awariach dla wszystkich użytkowników Twojej aplikacji (możesz zamiast tego wyłączyć automatyczne raportowanie o awariach i włączyć raportowanie dobrowolne dla swoich użytkowników). Crashlytics udostępnia cztery gotowe mechanizmy rejestrowania: klucze niestandardowe , dzienniki niestandardowe , identyfikatory użytkowników i przechwycone wyjątki .

Dodaj niestandardowe klucze

Klucze niestandardowe pomagają uzyskać określony stan aplikacji prowadzący do awarii. Możesz powiązać dowolne pary klucz/wartość z raportami o awariach, a następnie użyć kluczy niestandardowych do wyszukiwania i filtrowania raportów o awariach w konsoli Firebase.

• W panelu Crashlytics możesz wyszukiwać problemy pasujące do klucza niestandardowego.

• Przeglądając konkretny problem w konsoli, możesz wyświetlić powiązane klucze niestandardowe dla każdego zdarzenia (podkarta Klucze ), a nawet filtrować zdarzenia według kluczy niestandardowych (menu Filtruj u góry strony).

Uwaga: Crashlytics obsługuje maksymalnie 64 pary klucz/wartość. Po osiągnięciu tego progu dodatkowe wartości nie są zapisywane. Każda para klucz/wartość może mieć rozmiar do 1 kB.

Użyj metody instancji setCustomKey , aby ustawić pary klucz/wartość. Należy zauważyć, że setCustomKey jest przeciążony, aby parametr value akceptował dowolny argument pierwotny lub String . Oto kilka przykładów:

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("my_string_key", "foo") // String value
    key("my_bool_key", true) // boolean value
    key("my_double_key", 1.0) // double value
    key("my_float_key", 1.0f) // float value
    key("my_int_key", 1) // int value
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("my_string_key", "foo" /* string value */);

crashlytics.setCustomKey("my_bool_key", true /* boolean value */);

crashlytics.setCustomKey("my_double_key", 1.0 /* double value */);

crashlytics.setCustomKey("my_float_key", 1.0f /* float value */);

crashlytics.setCustomKey("my_int_key", 1 /* int value */);

Możesz także zmodyfikować wartość istniejącego klucza, wywołując klucz i ustawiając mu inną wartość. Na przykład:

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Dodaj zbiorczo pary klucz/wartość, przekazując instancję CustomKeysAndValues ​​do metody instancji setCustomKeys :

Kotlin+KTX

W przypadku Kotlina istniejąca funkcjonalność jest prostsza niż użycie konstruktora CustomKeysAndValues .

crashlytics.setCustomKeys {
  key("str_key", "hello")
  key("bool_key", true)
  key("int_key", 1)
  key("long_key", 1L)
  key("float_key", 1.0f)
  key("double_key", 1.0)
}

Java

CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
.putString("string key", "string value")
.putString("string key 2", "string  value 2")
.putBoolean("boolean key", True)
.putBoolean("boolean key 2", False)
.putFloat("float key", 1.01)
.putFloat("float key 2", 2.02)
.build();

FirebaseCrashlytics.getInstance().setCustomKeys(keysAndValues);

Dodaj niestandardowe komunikaty dziennika

Aby zapewnić sobie lepszy kontekst dla zdarzeń prowadzących do awarii, możesz dodać do swojej aplikacji niestandardowe dzienniki Crashlytics. Crashlytics kojarzy dzienniki z danymi o awariach i wyświetla je na stronie Crashlytics w konsoli Firebase , na karcie Dzienniki .

Uwaga: aby uniknąć spowolnienia aplikacji, Crashlytics ogranicza logi do 64 KB i usuwa starsze wpisy dziennika, gdy logi sesji przekraczają ten limit.

Użyj log , aby zidentyfikować problemy. Na przykład:

Kotlin+KTX

Firebase.crashlytics.log("message")

Java

FirebaseCrashlytics.getInstance().log("message");

Ustaw identyfikatory użytkowników

Aby zdiagnozować problem, często warto wiedzieć, który z użytkowników doświadczył danej awarii. Crashlytics umożliwia anonimową identyfikację użytkowników w raportach o awariach.

Aby dodać identyfikatory użytkowników do swoich raportów, przypisz każdemu użytkownikowi unikalny identyfikator w postaci numeru identyfikacyjnego, tokena lub wartości skrótu:

Kotlin+KTX

Firebase.crashlytics.setUserId("user123456789")

Java

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Jeśli kiedykolwiek będziesz musiał wyczyścić identyfikator użytkownika po jego ustawieniu, zresetuj wartość do pustego ciągu. Wyczyszczenie identyfikatora użytkownika nie powoduje usunięcia istniejących rekordów Crashlytics. Jeśli chcesz usunąć rekordy powiązane z identyfikatorem użytkownika, skontaktuj się z pomocą techniczną Firebase .

(Tylko Android NDK) Dodaj metadane do raportów o awariach NDK

Opcjonalnie możesz dołączyć nagłówek crashlytics.h do swojego kodu C++, aby dodać metadane do raportów o awariach NDK, takie jak niestandardowe klucze , niestandardowe dzienniki , identyfikatory użytkowników . Wszystkie te opcje zostały opisane na tej stronie powyżej.

crashlytics.h jest dostępny jako biblioteka C++ zawierająca tylko nagłówki w repozytorium GitHub Firebase Android SDK .

Przeczytaj komentarze w pliku nagłówkowym, aby uzyskać instrukcje dotyczące korzystania z interfejsów API NDK C++.

Dołącz raporty GWP-ASan, aby debugować problemy z uszkodzeniem pamięci

Crashlytics może pomóc w debugowaniu awarii spowodowanych błędami pamięci natywnej, zbierając raporty GWP-ASan. Te błędy związane z pamięcią mogą być powiązane z uszkodzeniem pamięci w aplikacji, co jest główną przyczyną luk w zabezpieczeniach aplikacji.

• Możesz wyświetlić te dane na nowej karcie „Ślady stosu pamięci”, klikając szczegóły problemu w panelu kontrolnym Crashlytics .

• Możesz także użyć nowego sygnału i filtra „Raport GWP-ASan”, aby szybko wyświetlić wszystkie problemy z tymi danymi.

Możesz uzyskać raporty dotyczące pamięci GWP-ASan, jeśli jawnie włączysz GWP-ASan w swojej aplikacji i użyjesz pakietu Crashlytics SDK dla NDK v18.3.6+ (Firebase BoM v31.3.0+). Możesz przetestować konfigurację GWP-ASan, korzystając z przykładowego kodu natywnego w dokumentacji Androida .

Zgłaszaj wyjątki niekrytyczne

Oprócz automatycznego raportowania awarii aplikacji Crashlytics umożliwia rejestrowanie wyjątków niekrytycznych i wysyłanie ich do Ciebie przy następnym uruchomieniu aplikacji.

Uwaga: Crashlytics przechowuje tylko osiem ostatnich zarejestrowanych wyjątków. Jeśli aplikacja zgłosi więcej niż osiem wyjątków, starsze wyjątki zostaną utracone.

Użyj metody recordException , aby zarejestrować wyjątki niekrytyczne w blokach catch aplikacji. Na przykład:

Kotlin+KTX

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

Java

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Ostrzeżenie: jeśli chcesz dołączyć unikalną wartość (na przykład identyfikator użytkownika lub sygnaturę czasową) do komunikatu o wyjątku, użyj klucza niestandardowego zamiast dodawać wartość bezpośrednio w komunikacie o wyjątku. Bezpośrednie dodanie wartości może spowodować kilka problemów i spowodować, że Crashlytics ograniczy błędy raportowania w Twojej aplikacji.

Wszystkie zarejestrowane wyjątki pojawiają się w konsoli Firebase jako problemy niekrytyczne. Podsumowanie problemu zawiera wszystkie informacje o stanie, które zwykle otrzymujesz w przypadku awarii, wraz z podziałem na wersję Androida i urządzenie sprzętowe.

Crashlytics przetwarza wyjątki w dedykowanym wątku w tle, aby zminimalizować wpływ na wydajność aplikacji. Aby zmniejszyć ruch sieciowy użytkowników, Crashlytics grupuje zarejestrowane wyjątki i wysyła je przy następnym uruchomieniu aplikacji.

Włącz raportowanie wyrażające zgodę

Domyślnie Crashlytics automatycznie zbiera raporty o awariach dla wszystkich użytkowników Twojej aplikacji. Aby dać użytkownikom większą kontrolę nad wysyłanymi danymi, możesz włączyć raportowanie, wyłączając automatyczne raportowanie i wysyłając dane do Crashlytics tylko wtedy, gdy tak zdecydujesz w swoim kodzie:

1. W bloku application pliku AndroidManifest.xml dodaj tag meta-data , aby wyłączyć automatyczne zbieranie:

   <meta-data
       android:name="firebase_crashlytics_collection_enabled"
       android:value="false" />
   

2. Włącz zbieranie dla wybranych użytkowników, wywołując zastąpienie gromadzenia danych Crashlytics w czasie wykonywania. Wartość zastąpienia będzie obowiązywać po każdym uruchomieniu Twojej aplikacji, więc Crashlytics może automatycznie zbierać raporty. Aby zrezygnować z automatycznego raportowania awarii, jako wartość zastąpienia podaj false . W przypadku ustawienia false nowa wartość nie zostanie zastosowana do następnego uruchomienia aplikacji.

   Kotlin+KTX

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Uwaga: gdy zbieranie danych jest wyłączone, Crashlytics będzie przechowywać informacje o awariach lokalnie na urządzeniu. Jeśli następnie włączono zbieranie danych, wszelkie informacje o awariach zapisane na urządzeniu zostaną przesłane do Crashlytics w celu przetworzenia.

Zarządzaj danymi Crash Insights

Crash Insights pomaga rozwiązywać problemy, porównując anonimowe ślady stosu ze śladami z innych aplikacji Firebase i informując, czy problem jest częścią większego trendu. W przypadku wielu problemów Crash Insights udostępnia nawet zasoby ułatwiające debugowanie awarii.

Crash Insights wykorzystuje zagregowane dane o awariach w celu identyfikacji typowych trendów stabilności. Jeśli nie chcesz udostępniać danych swojej aplikacji, możesz zrezygnować z Crash Insights w menu Crash Insights u góry listy problemów Crashlytics w konsoli Firebase .

Uwaga: wyłączenie udostępniania danych powoduje również usunięcie informacji o Twoich problemach. Zastosowanie zmian może zająć do 24 godzin.