Tuỳ chỉnh báo cáo sự cố trong Firebase Crashlytics

Trong trang tổng quan Crashlytics, bạn có thể nhấp vào một vấn đề và nhận thông tin chi tiết báo cáo sự kiện. 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 bạn và những tình huống liên quan đến 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 nắm bắt tất cả thông tin "gây hại" các lỗi được tạo ra trong Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError. Ngoài ra, để bắt được "không nghiêm trọng" ngoại lệ, 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 lỗi trình nghe 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 chúng cho bạn vào lần tiếp theo đượ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 quy trình phát hiện của ứng dụng chặ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 nên ghi lại thêm thông tin về lỗi (nếu có) bằ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. Chiến lược phát hành đĩa đơn bản tóm tắt vấn đề chứa tất cả thông tin về trạng thái mà bạn thường nhận được từ các sự cố, cùng với bảng phân tích 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 số lượng mạng mà người dùng sử dụng lưu lượng truy cập, Crashlytics sẽ giới hạn tỷ lệ 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 các vấn đề khớp với khoá tuỳ 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 khoá tuỳ chỉnh được liên kết cho từng sự kiện (thẻ phụ Khoá) và thậm chí lọc sự kiện bằng 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ị. Sau đâ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 bối cảnh về những sự kiện dẫn đến tai nạn, bạn có thể thêm nhật ký Crashlytics tuỳ chỉnh vào ứng dụng của bạn. Crashlytics liên kết các 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 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 một vấn đề, bạn nên biết được người dùng nào đã gặp phải vấn đề một sự cố cụ thể. Crashlytics có một cách giúp xác định danh tính ẩn danh của 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 của bạn, hãy chỉ định cho mỗi người dùng một giá trị nhận dạng duy nhất trong dạng số 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á một giá trị nhận dạng người dùng sẽ không xoá giá trị nhận dạng hiện có Bản ghi Crashlytics. Trường hợp bạn cần xoá các bản ghi được liên kết với một người dùng Mã nhận 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ề hoạt động tương tác của người dùng gặp phải 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 cố gắng tái tạo và gỡ lỗi sự cố.

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 của bạn và thêm Firebase SDK cho Google Analytics cho ứng dụng của bạn. Khi các yêu cầu này được đáp ứng, nhật ký breadcrumb (tập hợp liên kết phân cấp) sẽ tự động kèm theo 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 đề nào đó.

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 sự cố, sự cố 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 bất kỳ sự kiện tùy chỉnh mà bạn tự ghi lại trong phiên hoạt độ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ị 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.

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 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. Để mang lại cho người dùng nhiều quyền kiểm soát hơn đối với dữ liệu mà họ gửi, bạn có thể bật chọn tham gia báo cáo bằng cách tắt báo cáo tự động và chỉ gửi dữ liệu cho Crashlytics khi bạn chọn trong mã của mình:

  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 cho một số người dùng bằng cách gọi dữ liệu trên Crashlytics ghi đè bộ sưu tập trong thời gian 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, vì vậy, Crashlytics có thể tự động thu thập báo cáo. Để chọn không sử dụng tính năng tự động báo cáo sự cố, truyền false làm 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ố

Crash Insights giúp bạn giải quyết vấn đề bằng cách so sánh ngăn xếp ẩn danh dấu vết từ các ứng dụng Firebase khác và cho bạn biết vấn đề của một xu hướng lớn hơn. Đố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 Crash Insights trên trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề trong Crashlytics trong bảng điều khiển của Firebase.