Tuỳ chỉnh báo cáo lỗi trong Firebase Crashlytics

Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và nhận báo cáo sự kiện chi tiết. Bạn có thể tuỳ chỉnh các báo cáo đó để hiểu rõ hơn về điều gì đang xảy ra trong ứng dụng của bạn và tình huống liên quan đến 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 nắm bắt được

Bạn có thể tự động phát hiện tất cả các lỗi "nghiêm trọng" được tạo ra trong khung Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError. Ngoài ra, để phát hiện các ngoại lệ "không nghiêm trọng", 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ộ

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

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

Để phát hiện các 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 ngữ cảnh Flutter, hãy cài đặt một trình nghe 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ố của ứng dụng, Crashlytics cho phép bạn ghi lại các ngoại lệ không nghiêm trọng và gửi cho bạn vào lần tiếp theo 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 ngoại lệ không nghiêm trọng trong các khối catch của ứng dụng. 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 nên ghi lại thêm thông tin 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'],
);

Các ngoại lệ này xuất hiện dưới dạng vấn đề không nghiêm trọng trong bảng điều khiển của Firebase. Bản tóm tắt vấn đề chứa tất cả thông tin về trạng thái bạn thường nhận được sau 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 trường hợp ngoại lệ trên một luồng chuyên dụng ở chế độ nền để 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 số lượng báo cáo được gửi ra khỏi thiết bị, nếu cần.

Thêm khoá tuỳ chỉnh

Khoá tuỳ chỉnh giúp bạn biết được 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 giá trị/khoá tuỳ ý với báo cáo sự cố, sau đó sử dụng các khoá tuỳ chỉnh để tìm kiếm và lọc báo cáo sự cố trong bảng điều khiển của Firebase.

  • Trong trang tổng quan Crashlytics, bạn có thể tìm kiếm các vấn đề khớp với một khoá tuỳ chỉnh.

  • Khi xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các khoá tuỳ chỉnh được liên kết cho từng sự kiện (thẻ phụ Khoá) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Bộ lọc ở đầu trang).

Sử dụng phương thức thực thể setCustomKey để đặt các cặp khoá/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 nhật ký tuỳ chỉnh

Để có thêm ngữ cảnh về các sự kiện dẫn đến một sự cố, bạn có thể thêm nhật ký Crashlytics tuỳ 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ố và hiển thị chúng trong bảng điều khiển của Firebase, trong thẻ Nhật ký của Crashlytics.

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

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

Đặt giá trị nhận dạng người dùng

Để chẩn đoán một vấn đề, thông thường, bạn nên biết người dùng nào gặp phải một sự cố cụ thể. Crashlytics có 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 mã nhận dạng người dùng vào báo cáo, hãy chỉ định cho mỗi người dùng một giá trị nhận dạng duy nhất ở dạng mã nhận dạng, mã thông báo hoặc giá trị đã băm:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

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

Lấy nhật ký breadcrumb (tập hợp liên kết phân cấp)

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

Nhật ký breadcrumb do Google Analytics cung cấp. Do đó, để lấy nhật ký breadcrumb, 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 những yêu cầu này, nhật ký breadcrumb sẽ tự động được đi kèm với dữ liệu của sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về vấn đề.

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 khi xảy ra sự cố, sự kiện không nghiêm trọng hoặc lỗi ANR. Nhật ký breadcrumb screen_view chứa tham số firebase_screen_class.

Nhật ký Breadcrumb cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn tự ghi lại trong phiên hoạt động 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 nghiêm trọng hoặc lỗi ANR.

Xin 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 cả dữ liệu điền sẵn nhật ký breadcrumb (tập hợp liên kết phân cấp).

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

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

  1. Tắt tính năng thu thập tự động theo cách gốc:

    Nền tảng của Apple

    Thêm khoá mới vào tệp Info.plist:

    • Phím: 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. Bật tính năng thu thập cho một số người dùng bằng cách gọi chế độ ghi đè hoạt động thu thập dữ liệu của Crashlytics trong thời gian chạy.

    Giá trị ghi đè vẫn tồn tại trong các lần phát hành ứng dụng để Crashlytics có thể tự động thu thập báo cáo. Để chọn không tự động báo cáo sự cố, hãy chuyển false làm giá trị ghi đè. Khi được đặt thành false, giá trị mới sẽ không á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 Thông tin chi tiết về sự cố

Crash Insights giúp bạn giải quyết vấn đề bằng cách so sánh dấu vết ngăn xếp ẩn danh với dấu vết từ các ứng dụng Firebase khác, đồng thời cho bạn biết liệu vấn đề của bạn có thuộc một 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 các xu hướng phổ biến về độ ổn định. Nếu không muốn chia sẻ dữ liệu của ứng dụng, bạn có thể chọn không sử dụng Crash Insights trên trình đơn Crash Insights ở đầu danh sách vấn đề trên Crashlytics trong bảng điều khiển của Firebase.