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

iOS+ Android Flutter Unity

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

• Đo lường ứng dụng của bạn để ghi lại các khoá tuỳ chỉnh, thông báo nhật ký tuỳ chỉnh và các giá trị nhận dạng người dùng.

• Tự động nhận nhật ký đường dẫn nếu ứng dụng của bạn sử dụng Firebase SDK cho Google Analytics. Các nhật ký này giúp bạn biết được những hành động của người dùng dẫn đến một sự kiện được thu thập Crashlytics trong ứng dụng của bạn.

• Tắt tính năng báo cáo sự cố tự động và bật tính năng báo cáo chọn tham gia cho người dùng. Xin lưu ý rằng theo mặc định, Crashlytics sẽ tự động thu thập báo cáo sự cố gốc của nền tảng cho tất cả người dùng ứng dụng của bạn.

Lưu ý: Đối với các ứng dụng Flutter, báo cáo lỗi nghiêm trọng sẽ được gửi đến Crashlytics theo thời gian thực mà không cần người dùng khởi động lại ứng dụng. Các báo cáo không nghiêm trọng được ghi vào đĩa để gửi cùng với báo cáo nghiêm trọng tiếp theo hoặc khi ứng dụng khởi động lại.

Báo cáo các trường hợp ngoại lệ chưa được xử lý

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, để cũng nắm bắt 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 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 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ệ đã phát hiện

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

Lưu ý: Crashlytics chỉ lưu trữ 8 ngoại lệ không nghiêm trọng gần đây nhất đã được ghi lại. Nếu ứng dụng của bạn gửi nhiều hơn 8 trường hợp ngoại lệ, thì các trường hợp ngoại lệ cũ hơn sẽ bị mất. Số lượng này sẽ được đặt lại mỗi khi một ngoại lệ nghiêm trọng được gửi đi, vì điều này khiến một báo cáo được gửi đến Crashlytics.

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 có thể muốn ghi thêm thông tin về lỗi 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ảnh báo: Nếu bạn muốn thêm một giá trị duy nhất (ví dụ: mã nhận dạng người dùng hoặc dấu thời gian) vào thông báo ngoại lệ, hãy dùng khoá tuỳ chỉnh thay vì thêm giá trị trực tiếp vào thông báo ngoại lệ. Việc thêm trực tiếp các giá trị có thể dẫn đến một số vấn đề và có thể khiến Crashlytics giới hạn các lỗi báo cáo trong ứng dụng của bạn.

Những 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 Firebase. Bản tóm tắt vấn đề chứa tất cả thông tin trạng thái mà 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 trường hợp 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 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 tốc độ 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 trước khi xảy ra 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 Firebase.

• Trong Crashlytics trang tổng quan, bạn có thể tìm kiếm những 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).

Lưu ý: Crashlytics hỗ trợ tối đa 64 cặp khoá/giá trị. Sau khi bạn đạt đến ngưỡng này, các giá trị bổ sung sẽ không được lưu. Mỗi cặp khoá/giá trị có thể có kích thước tối đa 1 kB.

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 báo nhật ký tuỳ chỉnh

Để có thêm bối 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 sẽ liên kết nhật ký với dữ liệu sự cố và hiển thị nhật ký trong bảng điều khiển Firebase, trong thẻ Crashlytics Nhật ký.

Lưu ý: Để tránh làm chậm ứng dụng, Crashlytics giới hạn nhật ký ở mức 64 kB và xoá các mục nhật ký cũ hơn khi nhật ký của một phiên vượt quá giới hạn đó.

Sử dụng log để giúp xác định chính xá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 đề, bạn nên biết người dùng nào gặp phải một sự cố nhất định. Crashlytics bao gồm một cách để xác định người dùng ẩn danh 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ưới 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á mã 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 không xoá các bản ghi Crashlytics hiện có. Nếu bạn cần xoá các bản ghi được 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

Nhật ký đường dẫn cho phép bạn hiểu rõ hơn về những lượt tương tác mà người dùng đã thực hiện với ứng dụng của bạn trước khi xảy ra sự cố, lỗi 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ý đường dẫn được cung cấp bởi Google Analytics. Vì vậy, để nhận 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 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. Điều này cho phép nhật ký đường dẫn hiển thị danh sách các màn hình đã xem trước sự kiện gặp sự cố, không nghiêm trọng hoặc ANR. Nhật ký đường dẫn screen_view chứa tham số firebase_screen_class.

Nhật ký đường dẫn cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi nhật ký theo cách thủ công trong phiên hoạt động của người dùng, bao gồm cả dữ liệu tham số của sự kiện. Dữ liệu này có thể giúp cho thấy một loạt hành động của người dùng dẫn đến sự kiện sự cố, không nghiêm trọng hoặc 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 cho nhật ký đường dẫn.

Bật báo cáo chọn sử dụng

Nếu bật tính năng báo cáo chọn tham gia bằng cách tắt tính năng báo cáo tự động, bạn sẽ giảm độ chính xác của số lượng sự kiện và các chỉ số không có sự cố của ứng dụng. Điều này khiến các chỉ số này ít phản ánh độ ổn định tổng thể của ứng dụng hơn. Tìm hiểu thêm.

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 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 tính năng báo cáo chọn tham gia 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 trong mã của mình.

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

   Nền tảng của Apple

   Thêm một 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 đè tính năng thu thập dữ liệu Crashlytics tại thời gian chạy. Giá trị ghi đè sẽ duy trì trong tất cả các lần khởi chạy ứng dụng tiếp theo để Crashlytics có thể tự động thu thập báo cáo cho người dùng đó.

   FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
   

   Nếu sau này người dùng chọn không thu thập dữ liệu, bạn có thể truyền false làm giá trị ghi đè. Giá trị này sẽ áp dụng vào lần tiếp theo người dùng chạy ứng dụng và sẽ duy trì trong tất cả các lần chạy tiếp theo cho người dùng đó.

Lưu ý: Khi tính năng thu thập dữ liệu bị tắt đối với một người dùng, Crashlytics sẽ lưu trữ thông tin về sự cố trên thiết bị. Nếu sau đó bạn bật tính năng thu thập dữ liệu, mọi thông tin về sự cố được lưu trữ trên thiết bị sẽ được gửi đến Crashlytics để xử lý.

Quản lý dữ liệu trong 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 các dấu vết ngăn xếp ẩn danh của bạn với dấu vết của các ứng dụng Firebase khác và 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 các 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 ổn định thường gặp. 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ố trong 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 Firebase.

Lưu ý: Khi bạn tắt tính năng chia sẻ dữ liệu, thông tin chi tiết về các vấn đề của bạn cũng sẽ bị xoá. Các thay đổi có thể mất đến 24 giờ mới có hiệu lực.