Otrzymuj raporty o awariach Androida NDK

Jeśli Twoja aplikacja na Androida zawiera biblioteki natywne, możesz włączyć pełne zrzuty stosu i szczegółowe raporty o awariach dla kodu natywnego z poziomu Firebase Crashlytics, wprowadzając kilka drobnych zmian w konfiguracji kompilacji aplikacji.

Z tego przewodnika dowiesz się, jak skonfigurować zgłaszanie awarii za pomocą pakietu Firebase Crashlytics SDK dla NDK.

Jeśli szukasz informacji o tym, jak zacząć korzystać z Crashlytics w projektach w Unity, zapoznaj się z przewodnikiem dla początkujących na temat Unity.

Zanim zaczniesz

1. Jeśli jeszcze tego nie zrobiono, dodaj Firebase do projektu Androida. Jeśli nie masz aplikacji na Androida, możesz pobrać próbną aplikację.

2. Zalecane: aby automatycznie otrzymywać logi ścieżki, które pomogą Ci zrozumieć działania użytkowników prowadzące do awarii, niekrytycznych błędów lub zdarzeń ANR, musisz włączyć Google Analytics w projekcie Firebase.

   • Jeśli w dotychczasowym projekcie Firebase nie masz włączonej usługi Google Analytics, możesz ją włączyć na karcie Integracje w sekcji settings > Ustawienia projektu w konsoli Firebase.Google Analytics

   • Jeśli tworzysz nowy projekt Firebase, włącz Google Analytics w trakcie procesu tworzenia projektu.

3. Upewnij się, że aplikacja ma te minimalne wymagane wersje:

   • Gradle 8.0
   • Wtyczka Androida do obsługi Gradle 8.1.0
   • Wtyczka Gradle usług Google 4.4.1

Krok 1. Dodaj do aplikacji pakiet SDK Crashlytics dla NDK

Aby uzyskać optymalne wyniki w przypadku Crashlytics, zalecamy włączenie Google Analytics w projekcie Firebase i dodanie do aplikacji pakietu SDK Firebase dla Google Analytics.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk")
    implementation("com.google.firebase:firebase-analytics")
}

Dzięki użyciu Firebase Android BoMaplikacja zawsze będzie używać zgodnych wersji bibliotek Firebase na Androida.

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk:19.3.0")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

Krok 2. Dodaj do aplikacji wtyczkę Crashlytics Gradle

1. W pliku Gradle na poziomie katalogu głównego (na poziomie projektu) (<project>/build.gradle.kts lub <project>/build.gradle) dodaj wtyczkę Gradle Crashlytics do bloku plugins:

   Kotlin

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id("com.android.application") version "8.1.4" apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id("com.google.gms.google-services") version "4.4.2" apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id("com.google.firebase.crashlytics") version "3.0.2" apply false
   }

   Groovy

   plugins {
       // Make sure that you have the AGP plugin 8.1+ dependency
       id 'com.android.application' version '8.1.4' apply false
       // ...
   
       // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
       id 'com.google.gms.google-services' version '4.4.2' apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics' version '3.0.2' apply false
   }

2. W pliku Gradle modułu (na poziomie aplikacji) (zwykle <project>/<app-module>/build.gradle.kts lub <project>/<app-module>/build.gradle) dodaj wtyczkę Gradle Crashlytics:

   Kotlin

   plugins {
     id("com.android.application")
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id("com.google.gms.google-services")
   
     // Add the Crashlytics Gradle plugin
     id("com.google.firebase.crashlytics")
   }

   Groovy

   plugins {
     id 'com.android.application'
     // ...
   
     // Make sure that you have the Google services Gradle plugin
     id 'com.google.gms.google-services'
   
     // Add the Crashlytics Gradle plugin
     id 'com.google.firebase.crashlytics'
   }

Krok 3. Dodaj do kompilacji rozszerzenie Crashlytics

W pliku Gradle modułu (na poziomie aplikacji) (zwykle <project>/<app-module>/build.gradle.kts lub <project>/<app-module>/build.gradle) skonfiguruj rozszerzenie Crashlytics.

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
  // ...
  buildTypes {
      getByName("release") {
          // Add this extension
          configure<CrashlyticsExtension> {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled = true
          }
      }
  }
}

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

Krok 4. Skonfiguruj automatyczne przesyłanie symboli natywnych

Aby generować czytelne ścieżki stosu z awaryjnych NDK, Crashlytics musi znać symbole w natywnym binarnym. Wtyczka Gradle Crashlytics zawiera zadanie uploadCrashlyticsSymbolFileBUILD_VARIANT, które automatyzuje ten proces.

1. Aby mieć dostęp do zadania automatycznego przesyłania symboli, w pliku Gradle na poziomie modułu (aplikacji) ustaw wartość nativeSymbolUploadEnabled na true.

2. Aby nazwy metod były widoczne w śladach stosu, musisz wyraźnie wywołać zadanie uploadCrashlyticsSymbolFileBUILD_VARIANT po każdym wygenerowaniu biblioteki NDK. Przykład:

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT

3. Zarówno pakiet SDK Crashlytics dla NDK, jak i wtyczka Gradle Crashlytics zależą od obecności identyfikatora kompilacji GNU w obiektach natywnych współdzielonych.

   Obecność tego identyfikatora możesz zweryfikować, uruchamiając readelf -n w przypadku każdego binarnego pliku. Jeśli identyfikator kompilacji jest nieobecny, dodaj flagi -Wl,--build-id do flag systemu kompilacji, aby rozwiązać problem.

Krok 5. Wymuś awarię testową, aby zakończyć konfigurowanie

Aby dokończyć konfigurowanie Crashlytics i zobaczyć pierwsze dane na panelu Crashlytics w konsoli Firebase, musisz wymusić testowy błąd krytyczny.

1. Dodaj do aplikacji kod, który pozwoli Ci wymusić testowy błąd.

   Aby dodać do aplikacji przycisk, który po naciśnięciu powoduje awarię aplikacji, możesz użyć tego kodu w sekcji MainActivity. Przycisk ma etykietę „Testowy błąd”.

   Kotlin

   val crashButton = Button(this)
   crashButton.text = "Test Crash"
   crashButton.setOnClickListener {
      throw RuntimeException("Test Crash") // Force a crash
   }
   
   addContentView(crashButton, ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT))

   Java

   Button crashButton = new Button(this);
   crashButton.setText("Test Crash");
   crashButton.setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
          throw new RuntimeException("Test Crash"); // Force a crash
      }
   });
   
   addContentView(crashButton, new ViewGroup.LayoutParams(
          ViewGroup.LayoutParams.MATCH_PARENT,
          ViewGroup.LayoutParams.WRAP_CONTENT));

2. Zbuduj i uruchom aplikację.

3. Wymuś awarię testową, aby wysłać pierwszy raport o awarii aplikacji:

   1. Otwórz aplikację na urządzeniu testowym lub w emulatorze.

   2. W aplikacji kliknij przycisk „Test Crash”, który został dodany za pomocą kodu powyżej.

   3. Gdy aplikacja ulegnie awarii, uruchom ją ponownie, aby mogła wysłać raport o awarii do Firebase.

4. 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 będzie teraz monitorować Twoją aplikację pod kątem awarii. Możesz wyświetlać raporty i statystyki dotyczące awarii oraz je analizować w panelu Crashlytics.

Dalsze kroki

• (Zalecany) Aby pomóc w debugowaniu awarii spowodowanych błędami pamięci natywnej, zbierz raporty GWP-ASan. Te błędy związane z pamięcią mogą być związane z uszkodzeniem pamięci w aplikacji, co jest główną przyczyną luk w zabezpieczeniach aplikacji. Aby korzystać z tej funkcji debugowania, upewnij się, że w aplikacji GWP-ASan jest wyraźnie włączona i że używa ona najnowszej wersji pakietu Crashlytics SDK dla NDK (18.3.6 lub nowszej) lub Firebase BoM (31.3.0 lub nowszej).

• Dostosuj konfigurację raportów o awariach, dodając opcjonalne raportowanie, logi, klucze i śledzenie błędów niekrytycznych.

• Integracja z Google Play, dzięki której możesz filtrować raporty o awariach aplikacji na Androida według ścieżki Google Play bezpośrednio w panelu Crashlytics. Dzięki temu możesz lepiej dostosować panel do konkretnych wersji.

Rozwiązywanie problemów

Jeśli w konsoli Firebase i w pliku logcat widzisz różne ścieżki wywołań, zapoznaj się z przewodnikiem po rozwiązywaniu problemów.

Alternatywne opcje przesyłania symboli

Główny proces na tej stronie dotyczy standardowych kompilacji Gradle. Niektóre aplikacje korzystają jednak z innej konfiguracji lub narzędzi (np. z procesu kompilacji innego niż Gradle). W takich sytuacjach możesz skorzystać z tych opcji, aby przesłać symbole.

Opcja: przesyłaj symbole dla modułów biblioteki i zewnętrznych zależności

Ta opcja może być przydatna w tych sytuacjach:

• Jeśli używasz niestandardowego procesu kompilacji NDK w Gradle
• Jeśli natywne biblioteki są zbudowane w bibliotece lub module funkcji lub są dostarczane przez zewnętrzną firmę
• Jeśli automatyczne przesyłanie symboli nie działa lub na panelu widać niesymbolizowane awarie

Opcja: prześlij symbole dla wersji nieobejmujących Gradle lub niedostępnych nieobciętej biblioteki natywnej.

Ta opcja może być przydatna w tych sytuacjach:

• Jeśli używasz procesu kompilacji innego niż Gradle

• Jeśli nieobcięte biblioteki natywne są udostępniane w taki sposób, że nie są dostępne podczas kompilacji Gradle