Nhận báo cáo sự cố của Android NDK

Nếu ứng dụng Android của bạn có chứa thư viện gốc, thì 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 từ Firebase Crashlytics thông qua một vài bản cập nhật nhỏ cho cấu hình bản dựng của ứng dụng.

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 các dự án Unity của mình, hãy xem 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 của bạn 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 một ứng dụng mẫu xuống.

  2. Đề xuất: Để tự động nhận nhật ký đường dẫn nhằm tìm hiểu các hành động của người dùng dẫn đến sự cố, sự kiện không nghiêm trọng hoặc lỗi 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 trong > Cài đặt dự án trong bảng điều khiển của Firebase.

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

  3. Đảm bảo rằng ứng dụng của bạn có các phiên bản bắt buộc 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 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), hãy 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 SDK Firebase cho Google Analytics vào ứng dụng của mình. 

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.0.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 các phiên bản tương thích của thư viện Android Firebase.

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

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

Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng của mình, 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 rằng mọi 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.0.0")
    implementation("com.google.firebase:firebase-analytics:22.0.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ể sử dụng mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem phần 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 cho 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 cho Crashlytics vào 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.1" apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id("com.google.firebase.crashlytics") version "3.0.0" 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.1' apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id 'com.google.firebase.crashlytics' version '3.0.0' 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), hãy 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 ký hiệu trong tệp nhị phân gốc của bạn. Trình bổ trợ Gradle cho Crashlytics có tác vụ uploadCrashlyticsSymbolFileBUILD_VARIANT để tự động hoá quy trình này.

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

  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 tác vụ uploadCrashlyticsSymbolFileBUILD_VARIANT một cách rõ ràng 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 dành cho NDK và trình bổ trợ Gradle cho Crashlytics đều 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 từng tệp nhị phân. Nếu không có mã bản dựng, hãy thêm -Wl,--build-id vào cờ của hệ thống xây dựng để khắc phục vấn đề.

Bước 5: Buộc một 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 của Firebase, bạn cần buộc xảy ra sự cố thử nghiệm.

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

    Bạn có thể sử dụng mã sau trong MainActivity của ứng dụng để thêm một nút vào ứng dụng. Nút này sẽ gây ra sự cố khi được nhấn. Nút này có nhãn "Test Crash" (Kiểm thử 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 thử nghiệm sự cố để gửi báo cáo sự cố đầu tiên của ứng dụng:

    1. Mở ứng dụng trên thiết bị kiểm thử hoặc trình mô phỏng.

    2. Trong ứng dụng, hãy nhấn 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 có thể gửi báo cáo sự cố cho Firebase.

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

    Nếu đã làm mới bảng điều khiển mà 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 liệu ứng dụng có đang 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 sự cố. Bạn có thể xem cũng như tìm hiểu báo cáo sự cố và số liệu thống kê trong trang tổng quan Crashlytics.

Các bước tiếp theo

  • (Nên dùng) Nhận trợ giúp khắc phục sự cố do lỗi bộ nhớ gốc bằng cách thu thập các báo cáo GWP-ASan. Những lỗi liên quan đến bộ nhớ này có thể liên quan đến tình trạng hỏng bộ nhớ trong ứng dụng của bạn. Đây là nguyên nhân hàng đầu gây ra các lỗ hổng bảo mật ứ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 đã bật GWP-ASan một cách rõ ràng và sử dụng SDK Crashlytics mới nhất dành cho NDK (phiên bản 18.3.6 trở lên 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 chọn sử dụng, nhật ký, khoá và tính năng theo dõi các 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 kênh trên Google Play ngay trong trang tổng quan của Crashlytics. Nhờ đó, bạn có thể tập trung hiệu quả hơn vào trang tổng quan vào các bản dựng cụ thể.

Khắc phục sự cố

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


Các cách khác để tải biểu tượng lên

Quy trình làm việc chính trên trang này ở trên có thể á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ụ: quy trình xây dựng không phải Gradle). Trong những trường hợp như vậy, các tuỳ chọn sau có thể hữu ích để tải biểu tượng lên thành công.

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

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 xây dựng trong 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 các sự cố không dùng biểu tượng trong trang tổng quan

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

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 không phải Gradle

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