Tùy chỉnh báo cáo sự cố Firebase Crashlytics của bạn

Trong bảng điều khiển Crashlytics, bạn có thể nhấp vào một sự cố và nhận báo cáo sự kiện chi tiết. Bạn có thể tùy chỉnh các báo cáo đó để giúp bạn hiểu rõ hơn những gì đang xảy ra trong ứng dụng của mình và các trường hợp xung quanh các sự kiện được báo cáo cho Crashlytics.

Báo cáo các trường hợp ngoại lệ chưa được phát hiện

Bạn có thể tự động phát hiện tất cả các lỗi "nghiêm trọng" được đưa ra trong khung Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError . Ngoài ra, để nắm bắt các ngoại lệ "không gây tử vong", hãy ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterError :

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();
  bool weWantFatalErrorRecording = true;
  FlutterError.onError = (errorDetails) {
    if(weWantFatalErrorRecording){
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    } else {
      FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
    }
  };

  runApp(MyApp());
}

Lỗi không đồng bộ

Flutter framework không phát hiện được các lỗi không đồng bộ:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Để phát hiện những lỗi như vậy, bạn có thể sử dụng trình xử lý PlatformDispatcher.instance.onError :

Future<void> main() async {
    WidgetsFlutterBinding.ensureInitialized();
    await Firebase.initializeApp();
    FlutterError.onError = (errorDetails) {
      FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
    };
    // Pass all uncaught asynchronous errors that aren't handled by the Flutter framework to Crashlytics
    PlatformDispatcher.instance.onError = (error, stack) {
      FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
      return true;
    };
    runApp(MyApp());

}

Lỗi bên ngoài Flutter

Để phát hiện các lỗi xảy ra bên ngoài bối cảnh Flutter, hãy cài đặt trình xử lý lỗi trên Isolate hiện tại:

Isolate.current.addErrorListener(RawReceivePort((pair) async {
  final List<dynamic> errorAndStacktrace = pair;
  await FirebaseCrashlytics.instance.recordError(
    errorAndStacktrace.first,
    errorAndStacktrace.last,
    fatal: true,
  );
}).sendPort);

Báo cáo các trường hợp ngoại lệ bị phát hiện

Ngoài việc tự động báo cáo sự cố ứng dụng của bạn, Crashlytics còn cho phép bạn ghi lại các trường hợp ngoại lệ không gây tử vong và gửi chúng cho bạn vào lần tiếp theo khi một sự kiện nghiêm trọng được báo cáo hoặc khi ứng dụng khởi động lại.

Sử dụng phương thức recordError để ghi lại các trường hợp ngoại lệ không nghiêm trọng trong khối bắt của ứng dụng của bạn. Ví dụ:

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error'
);

// Or you can use:
await FirebaseCrashlytics.instance.recordFlutterError(errorDetails);

Bạn cũng có thể muốn ghi lại thông tin thêm về lỗi có thể xảy ra bằng cách sử dụng thuộc tính information :

await FirebaseCrashlytics.instance.recordError(
  error,
  stackTrace,
  reason: 'a non-fatal error',
  information: ['further diagnostic information about the error', 'version 2.0'],
);

Những trường hợp ngoại lệ này xuất hiện dưới dạng sự cố không nghiêm trọng trong bảng điều khiển Firebase. Bản tóm tắt sự cố chứa tất cả thông tin trạng thái bạn thường nhận được khi gặp sự cố, cùng với thông tin chi tiết theo phiên bản và thiết bị phần cứng.

Crashlytics xử lý các ngoại lệ trên một luồng nền chuyên dụng để giảm thiểu tác động đến hiệu suất đối với ứng dụng của bạn. Để giảm lưu lượng truy cập mạng của người dùng, Crashlytics sẽ giới hạn tỷ lệ số lượng báo cáo được gửi khỏi thiết bị, nếu cần.

Thêm phím tùy chỉnh

Khóa tùy chỉnh giúp bạn biết trạng thái cụ thể của ứng dụng dẫn đến sự cố. Bạn có thể liên kết các cặp khóa/giá trị tùy ý với báo cáo sự cố của mình, sau đó sử dụng các khóa tùy chỉnh để tìm kiếm và lọc báo cáo sự cố trong bảng điều khiển Firebase.

  • Trong bảng điều khiển Crashlytics , bạn có thể tìm kiếm các vấn đề khớp với khóa tùy chỉnh.

  • Khi đang xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các khóa tùy chỉnh liên quan cho từng sự kiện ( tab phụ Keys ) và thậm chí lọc các sự kiện theo các khóa tùy chỉnh ( Menu bộ lọc ở đầu trang).

Sử dụng phương thức phiên bản setCustomKey để đặt các cặp khóa/giá trị. Dưới đây là một số ví dụ:

// Set a key to a string.
FirebaseCrashlytics.instance.setCustomKey('str_key', 'hello');

// Set a key to a boolean.
FirebaseCrashlytics.instance.setCustomKey("bool_key", true);

// Set a key to an int.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1);

// Set a key to a long.
FirebaseCrashlytics.instance.setCustomKey("int_key", 1L);

// Set a key to a float.
FirebaseCrashlytics.instance.setCustomKey("float_key", 1.0f);

// Set a key to a double.
FirebaseCrashlytics.instance.setCustomKey("double_key", 1.0);

Thêm thông điệp tường trình tùy chỉnh

Để cung cấp thêm thông tin về các sự kiện dẫn đến sự cố, bạn có thể thêm nhật ký Crashlytics tùy chỉnh vào ứng dụng của mình. Crashlytics liên kết nhật ký với dữ liệu sự cố của bạn và hiển thị chúng trong bảng điều khiển Firebase , trong tab Nhật ký Crashlytics.

Sử dụng log để giúp xác định vấn đề. Ví dụ:

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Đặt định danh người dùng

Để chẩn đoán sự cố, việc biết người dùng nào của bạn đã gặp phải sự cố nhất định thường rất hữu ích. Crashlytics bao gồm một cách để xác định ẩn danh người dùng trong báo cáo sự cố của bạn.

Để thêm ID người dùng vào báo cáo của bạn, hãy chỉ định cho mỗi người dùng một mã định danh duy nhất dưới dạng số ID, mã thông báo hoặc giá trị băm:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Nếu bạn cần xóa mã định danh người dùng sau khi đặt nó, hãy đặt lại giá trị thành một chuỗi trống. Việc xóa mã định danh người dùng sẽ không xóa các bản ghi Crashlytics hiện có. Nếu bạn cần xóa các bản ghi được liên kết với ID người dùng, hãy liên hệ với bộ phận hỗ trợ của Firebase .

Nhận nhật ký đường dẫn

Nhật ký Breadcrumb giúp bạn hiểu rõ hơn về các tương tác mà người dùng thực hiện với ứng dụng của bạn dẫn đến sự cố, sự kiện không gây tử vong hoặc ANR. Những nhật ký này có thể hữu ích khi cố gắng tái tạo và gỡ lỗi một sự cố.

Nhật ký đường dẫn được cung cấp bởi Google Analytics, do đó, để có được nhật ký đường dẫn, bạn cần bật Google Analytics cho dự án Firebase và thêm SDK Firebase cho Google Analytics vào ứng dụng của mình. Sau khi đáp ứng các yêu cầu này, nhật ký đường dẫn sẽ tự động được đưa vào dữ liệu của sự kiện trong tab Nhật ký khi bạn xem chi tiết về sự cố.

SDK Analytics tự động ghi lại sự kiện screen_view để cho phép nhật ký đường dẫn hiển thị danh sách các màn hình được xem trước sự cố, sự kiện không gây tử vong hoặc ANR. Nhật ký breadcrumb screen_view chứa tham số firebase_screen_class .

Nhật ký Breadcrumb cũng được điền với bất kỳ sự kiện tùy chỉnh nào mà bạn đăng nhập theo cách thủ công trong phiên của người dùng, bao gồm cả dữ liệu thông số của sự kiện. Dữ liệu này có thể giúp hiển thị một loạt hành động của người dùng dẫn đến sự cố, sự kiện không gây tử vong hoặc ANR.

Lưu ý rằng bạn có thể kiểm soát việc thu thập và sử dụng dữ liệu Google Analytics , bao gồm dữ liệu điền vào nhật ký đường dẫn.

Bật báo cáo chọn tham gia

Theo mặc định, Crashlytics tự động thu thập các báo cáo sự cố cho tất cả người dùng ứng dụng của bạn. Để cung cấp cho người dùng nhiều quyền kiểm soát hơn đối với dữ liệu họ gửi, bạn có thể bật báo cáo chọn tham gia bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu tới Crashlytics khi bạn chọn trong mã của mình:

  1. Tắt bộ sưu tập tự động nguyên bản:

    Nền tảng của Apple

    Thêm khóa mới vào tệp Info.plist của bạn:

    • Khóa: FirebaseCrashlyticsCollectionEnabled
    • Giá trị: false

    Android

    Trong khối application của tệp AndroidManifest.xml , hãy thêm thẻ meta-data để tắt tính năng thu thập tự động:

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

  2. Cho phép thu thập cho những người dùng được chọn bằng cách gọi ghi đè thu thập dữ liệu Crashlytics khi chạy.

    Giá trị ghi đè vẫn tồn tại trong các lần khởi chạy ứng dụng của bạn để Crashlytics có thể tự động thu thập báo cáo. Để chọn không tham gia báo cáo sự cố tự động, hãy chuyển false làm giá trị ghi đè. Khi được đặt thành false , giá trị mới không được áp dụng cho đến lần chạy ứng dụng tiếp theo.

    FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);

Quản lý dữ liệu Crash Insights

Crash Insights giúp bạn giải quyết sự cố bằng cách so sánh dấu vết ngăn xếp ẩn danh của bạn với dấu vết từ các ứng dụng Firebase khác và cho bạn biết liệu sự cố của bạn có phải là một phần của xu hướng lớn hơn hay không. Đối với nhiều vấn đề, Crash Insights thậm chí còn cung cấp tài nguyên để giúp bạn gỡ lỗi sự cố.

Crash Insights sử dụng dữ liệu sự cố tổng hợp để xác định xu hướng ổn định chung. Nếu không muốn chia sẻ dữ liệu ứng dụng của mình, bạn có thể chọn không tham gia Crash Insights từ menu Crash Insights ở đầu danh sách sự cố Crashlytics trong bảng điều khiển Firebase .