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 dấu vết ngăn xếp đầy đủ và báo cáo sự cố chi tiết cho mã gốc từ Firebase Crashlytics bằng một vài bản cập nhật nhỏ đối với 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, 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 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ý đường dẫn nhằm hiểu rõ các 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.

   • 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 settings > 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 tối thiểu bắt buộc sau:

   • Gradle 8.0
   • Trình bổ trợ Android cho Gradle 8.1.0
   • Trình bổ trợ Google Services cho Gradle 4.4.1

Bước 1: Thêm SDK Crashlytics cho NDK vào ứng dụng

Để 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.

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

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.2.1")
    implementation("com.google.firebase:firebase-analytics:22.1.2")
}

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 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.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), 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.

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

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 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 tác vụ uploadCrashlyticsSymbolFileBUILD_VARIANT để tự động hoá quy trình này.

1. Để bạn có thể truy cập vào tác vụ tải biểu tượng lên tự động, hãy đảm bảo rằng nativeSymbolUploadEnabled được đặt thành true trong tệp Gradle của 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 rõ ràng tác vụ 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ợ Gradle 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 dùng chung gốc.

   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 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 sự cố.

Bước 5: Buộc sự cố kiểm thử để hoàn tất việc 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 một nút vào ứng dụng. Khi nhấn nút này, ứng dụng sẽ gặp sự cố. 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.

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 trên thiết bị kiểm thử 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 gặp sự cố, hãy khởi động lại ứng dụng để ứng dụng có thể gửi báo cáo sự cố đến 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.

Vậy là xong! Crashlytics hiện đang theo dõi sự cố trong ứng dụng của bạn. Bạn có thể xem và điều tra báo cáo sự cố cũng như số liệu thống kê trong trang tổng quan 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 đã bật GWP-ASan một cách rõ ràng và sử dụng SDK Crashlytics mới nhất 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 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 kênh Google Play ngay trong trang tổng quan Crashlytics. Nhờ đó, bạn có thể tập trung hơn vào các bản dựng cụ thể trên trang tổng quan.

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 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 công việc chính trên trang này áp dụng cho các bản dựng Gradle 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 tạo bản dựng không phải Gradle). Trong những trường hợp này, các tuỳ chọn sau đây có thể giúp bạn 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

Lựa 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 tạo bản 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 lên tự động không thành công hoặc bạn thấy các sự cố không được biểu tượng hoá trong trang tổng quan

Lựa chọn: Tải 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 truy cập được

Lựa 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