Nhận báo cáo sự cố về Android NDK

Nếu ứng dụng Android của bạn chứa thư viện gốc, bạn có thể bật toàn bộ dấu vết ngăn xếp và báo cáo sự cố chi tiết cho mã gốc của mình từ Firebase Crashlytics cùng với một vài bản cập nhật nhỏ cho bản dựng ứng dụng của bạn .

Hướng dẫn này mô tả cách định cấu hình tính năng báo cáo sự cố bằng SDK Firebase Crashlytics cho NDK.

Nếu bạn đang tìm cách bắt đầu sử dụng Crashlytics trong Unity hãy xem các dự án Hướng dẫn bắt đầu sử dụng Unity.

Trước khi bắt đầu

  1. Thêm Firebase vào dự án Android nếu bạn chưa thực hiện. Nếu không có ứng dụng Android, bạn có thể tải ứng dụng mẫu xuống.

  2. Đề xuất: Để tự động nhận nhật ký breadcrumb (tập hợp liên kết phân cấp) để tìm hiểu hành động của người dùng dẫn đến sự cố, sự cố không nghiêm trọng hoặc sự kiện ANR, bạn cần bật Google Analytics trong dự án Firebase của mình.

    • Nếu dự án Firebase hiện tại của bạn chưa bật Google Analytics, bạn có thể bật Google Analytics từ thẻ Tích hợp của > Cài đặt dự án trong bảng điều khiển Firebase.

    • Nếu bạn đang tạo dự án Firebase mới, hãy bật Google Analytics trong quy trình tạo dự án.

  3. Đảm bảo ứng dụng của bạn có các phiên bản được yêu cầu tối thiểu sau đây:

    • Gradle 8.0
    • Trình bổ trợ Android cho Gradle 8.1.0
    • Trình bổ trợ Gradle cho các dịch vụ của Google 4.4.1

Bước 1: Thêm SDK Crashlytics dành cho NDK vào ứng dụng của bạn

Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm phần phụ thuộc cho thư viện NDK Crashlytics cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện.

Để có trải nghiệm tối ưu với Crashlytics, bạn nên bật Google Analytics trong dự án Firebase và thêm Firebase SDK cho Google Analytics vào ứng dụng của bạn. 

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.3.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")
}

Bằng cách sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng những phiên bản tương thích của thư viện Android trên Firebase.

(Phương án thay thế) Thêm các phần phụ thuộc của thư viện Firebase mà không sử dụng BoM

Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc của thư viện đó.

Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện, nhằm đảm bảo tất cả phiên bản đều tương thích. 

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.1.0")
    implementation("com.google.firebase:firebase-analytics:22.1.0")
}
Bạn đang tìm một mô-đun thư viện dành riêng cho Kotlin? Kể từ tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).

Bước 2: Thêm trình bổ trợ Gradle Crashlytics vào ứng dụng

  1. Trong tệp Gradle cấp gốc (cấp dự án) (<project>/build.gradle.kts hoặc <project>/build.gradle), hãy thêm Trình bổ trợ Gradle Crashlytics cho khối 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. Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm trình bổ trợ 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'
}

Bước 3: Thêm tiện ích Crashlytics vào bản dựng

Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy định cấu hình tiện ích Crashlytics.

Kotlin 

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
          }
      }
  }
}

Groovy 

// ...

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
          }
      }
  }
}

Bước 4: Thiết lập tính năng tự động tải biểu tượng gốc lên

Để tạo ra dấu vết ngăn xếp có thể đọc được từ các sự cố NDK, Crashlytics cần biết về các biểu tượng trong tệp nhị phân gốc. Trình bổ trợ Gradle Crashlytics bao gồm uploadCrashlyticsSymbolFileBUILD_VARIANT để tự động hoá quy trình này.

  1. Để bạn có thể truy cập vào nhiệm vụ tải biểu tượng tự động lên, hãy đảm bảo nativeSymbolUploadEnabled được đặt thành true trong mô-đun của bạn (cấp ứng dụng) Tệp Gradle.

  2. Để tên phương thức xuất hiện trong dấu vết ngăn xếp, bạn phải gọi một cách rõ ràng uploadCrashlyticsSymbolFileBUILD_VARIANT sau mỗi bản dựng của thư viện NDK. Ví dụ:

    >./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT

  3. Cả SDK Crashlytics cho NDK và trình bổ trợ Crashlytics cho Gradle phụ thuộc vào sự hiện diện của mã bản dựng GNU trong các đối tượng gốc dùng chung.

    Bạn có thể xác minh sự hiện diện của mã nhận dạng này bằng cách chạy readelf -n trên mỗi tệp nhị phân. Nếu mã bản dựng là không có, hãy thêm -Wl,--build-id vào cờ để khắc phục sự cố này.

Bước 5: Xác định sự cố thử nghiệm để hoàn tất quá trình thiết lập

Để hoàn tất việc thiết lập Crashlytics và xem dữ liệu ban đầu trong trang tổng quan Crashlytics của bảng điều khiển Firebase, bạn cần buộc một sự cố kiểm thử.

  1. Thêm mã vào ứng dụng mà bạn có thể dùng để buộc xảy ra sự cố kiểm thử.

    Bạn có thể sử dụng mã sau trong MainActivity của ứng dụng để thêm nút cho ứng dụng của bạn và khi được nhấn, sẽ gây ra sự cố. Nút này được gắn nhãn "Thử nghiệm sự cố".

    Kotlin+KTX 

    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. Tạo bản dựng và chạy ứng dụng của bạn.

  3. Buộc sự cố kiểm thử xảy ra để gửi báo cáo sự cố đầu tiên của ứng dụng:

    1. Mở ứng dụng của bạn từ thiết bị thử nghiệm hoặc trình mô phỏng.

    2. Trong ứng dụng, hãy nhấn vào nút "Test Crash" (Kiểm thử sự cố) mà bạn đã thêm bằng mã ở trên.

    3. Sau khi ứng dụng của bạn gặp sự cố, hãy khởi động lại ứng dụng để ứng dụng của bạn có thể gửi sự cố báo cáo cho Firebase.

  4. Chuyển đến trang tổng quan Crashlytics của bảng điều khiển Firebase để xem sự cố kiểm thử.

    Nếu bạn đã làm mới bảng điều khiển và vẫn không thấy sự cố kiểm thử sau 5 phút, hãy bật tính năng ghi nhật ký gỡ lỗi để xem ứng dụng của bạn có gửi báo cáo sự cố hay không.


Chỉ vậy thôi! Crashlytics hiện đang theo dõi ứng dụng của bạn để phát hiện các sự cố và bạn có thể xem và điều tra báo cáo sự cố và số liệu thống kê trong Trang tổng quan của Crashlytics.

Các bước tiếp theo

  • (Nên dùng) Yêu cầu trợ giúp gỡ lỗi sự cố do lỗi bộ nhớ gốc gây ra bằng cách thu thập báo cáo GWP-ASan. Các lỗi liên quan đến bộ nhớ này có thể liên quan đến việc hỏng bộ nhớ trong ứng dụng của bạn. Đây là nguyên nhân chính gây ra các lỗ hổng bảo mật của ứng dụng. Để tận dụng tính năng gỡ lỗi này, hãy đảm bảo ứng dụng của bạn có GWP-ASan được bật rõ ràng và sử dụng SDK Crashlytics mới nhất cho NDK (phiên bản 18.3.6+ hoặc Firebase BoM phiên bản 31.3.0 trở lên).

  • Tuỳ chỉnh chế độ thiết lập báo cáo sự cố bằng cách thêm tính năng báo cáo tuỳ chọn, nhật ký, khoá và tính năng theo dõi lỗi không nghiêm trọng.

  • Tích hợp với Google Play để bạn có thể lọc báo cáo sự cố của ứng dụng Android theo Google Play theo dõi ngay trong Trang tổng quan Crashlytics. Điều này cho phép bạn tập trung tốt hơn vào trang tổng quan của mình vào các bản dựng cụ thể.

Khắc phục sự cố

Nếu bạn thấy nhiều dấu vết ngăn xếp trong bảng điều khiển Firebase và trong logcat, hãy tham khảo Hướng dẫn khắc phục sự cố.


Các lựa chọn thay thế để tải biểu tượng lên

Quy trình làm việc chính trên trang ở trên này áp dụng cho các bản dựng Gradle tiêu chuẩn. Tuy nhiên, một số ứng dụng sử dụng cấu hình hoặc công cụ khác (ví dụ: bản dựng khác Gradle). Trong những trường hợp này, các phương án sau có thể rất hữu ích để tải biểu tượng lên thành công.

Tuỳ chọn: Tải biểu tượng lên cho các mô-đun thư viện và phần phụ thuộc bên ngoài

Tuỳ chọn này có thể hữu ích trong các trường hợp sau:

  • Nếu bạn sử dụng một quy trình xây dựng NDK tuỳ chỉnh trong Gradle
  • Nếu thư viện gốc của bạn được tạo trong một mô-đun thư viện/tính năng hoặc do bên thứ ba cung cấp
  • Nếu tác vụ tải biểu tượng tự động lên không thành công hoặc bạn thấy sự cố không có biểu tượng trong trang tổng quan

Tuỳ chọn: Tải biểu tượng lên cho các bản dựng không dựa trên Gradle hoặc các thư viện gốc chưa gỡ bỏ và không thể truy cập được

Tuỳ chọn này có thể hữu ích trong các trường hợp sau:

  • Nếu bạn sử dụng quy trình xây dựng không phải Gradle

  • Nếu thư viện gốc chưa bị loại bỏ được cung cấp cho bạn theo cách nào đó mà bạn không thể truy cập được trong các bản dựng Gradle