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

Trên 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 những gì đang xảy ra trong ứng dụng của mình và các trường hợp xảy ra liên quan đến các sự kiện được báo cáo cho Crashlytics.

Báo cáo 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 trường hợp 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 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ệ phát hiện được

Ngoài việc tự động báo cáo sự cố của ứng dụng, Crashlytics còn 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 bắt 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 từ các 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 chuyên biệt ở chế độ nền để giảm thiểu tác động đến hiệu suất của ứng dụng. Để 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 khoá/giá trị 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 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 liên kết cho từng sự kiện (thẻ con Khoá) và thậm chí là lọc sự kiện theo các 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ặ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 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 về sự cố và hiển thị các nhật ký đó 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 sự cố. 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 sự cố, bạn nên biết được 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ố.

Để 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ưới dạng số 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á 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 nhóm hỗ trợ Firebase.

Nhận 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ề những hành động 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ự cố không nghiêm trọng hoặc sự kiện ANR. Các nhật ký này có thể hữu ích khi bạn cố gắng tái tạo và gỡ lỗi một vấn đề.

Nhật ký breadcrumb (tập hợp liên kết phân cấp) do Google Analytics cung cấp. Vì vậy, để nhận nhật ký breadcrumb (tập hợp liên kết phân cấp), bạn cần bật Google Analytics cho dự án Firebase và thêm Firebase SDK 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ý breadcrumb (tập hợp liên kết phân cấp) sẽ tự động được đưa vào dữ liệu của một sự kiện trong thẻ Nhật ký khi bạn xem thông tin chi tiết về một vấn đề.

SDK Analytics tự động ghi lại sự kiện screen_view, cho phép nhật ký breadcrumb (tập hợp liên kết phân cấp) hiển thị danh sách các màn hình đã xem trước khi xảy ra sự cố, sự kiện không nghiêm trọng hoặc sự kiện ANR. Nhật ký breadcrumb (tập hợp liên kết phân cấp) 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 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 sự kiện 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 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 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 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 tính năng báo cáo chọn sử dụng 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 sử dụng trong mã:

  1. Cách tắt tính năng thu thập tự động:

    Nền tảng của Apple

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

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

    Giá trị ghi đè vẫn tồn tại trong các lần 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 tự động báo cáo sự cố, hãy truyền false dưới dạng giá trị ghi đè. Khi bạn đặ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ố

Thông tin chi tiết về sự cố 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 của 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ó nằm trong 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ố.

Thông tin chi tiết về sự cố 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 Thông tin chi tiết về sự cố trên trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề Crashlytics trong bảng điều khiển của Firebase.