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

iOS+ Android Flutter Unity

Trong trang tổng quan của Crashlytics, bạn có thể nhấp vào một vấn đề để xem 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 các ngoại lệ chưa nắm bắt được và các ngoại lệ đã nắm bắt được cho Crashlytics.

• Đo lường ứng dụng của bạn để ghi lại khoá tuỳ chỉnh, thông báo nhật ký tuỳ chỉnh và mã 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 SDK Firebase cho Google Analytics. Các nhật ký này cho bạn biết về các hành động của người dùng dẫn đến một sự kiện do Crashlytics thu thập trong ứng dụng.

• Tắt tính năng tự động báo cáo sự cố và bật báo cáo chọn tham gia cho người dùng của mình. Lưu ý rằng, bằng cách mặc định, Crashlytics sẽ tự động thu thập báo cáo sự cố có sẵn trên 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 nghiêm trọng sẽ được gửi đến Crashlytics theo thời gian thực mà người dùng không cần khởi động lại ứng dụng. Báo cáo không nghiêm trọng là đượ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 sẽ khởi động lại.

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 nắm bắt tất cả thông tin "gây hại" các lỗi được tạo ra trong Flutter khung 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 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

Ngoài việc tự động báo cáo lỗi 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.

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

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ảnh báo: Nếu bạn muốn đưa 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 sử 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 giá trị có thể dẫn đến nhiều vấn đề và có thể khiến Crashlytics giới hạn lỗi báo cáo trong ứng dụng của bạn.

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

• Trong trang tổng quan của Crashlytics, bạn có thể tì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 được liên kết cho từng sự kiện (thẻ con Khoá) và thậm chí lọc các sự kiện theo khoá tuỳ chỉnh (trình đơn Lọc ở đầu trang).

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

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

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ập 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 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ó cách nhận dạng ẩ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 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á 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ã 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ý đường dẫn giúp bạn hiểu rõ hơn về các hoạt độ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 cố gắng tái tạo và gỡ lỗi sự cố.

Nhật ký chuỗi dẫn đường được cung cấp bởi Google Analytics. Vì vậy, để nhận nhật ký chuỗi dẫn đường, 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. Sau khi đáp ứng các yêu cầu này, nhật ký chuỗi dẫn đường 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ý đường dẫn dẫn đến sự kiện hiển thị danh sách màn hình đã xem trước sự kiện sự cố, sự cố không nghiêm trọng hoặc ANR. Nhật ký đường dẫn breadcrumb screen_view chứa tham số firebase_screen_class.

Nhật ký chuỗi liên kết cũng được điền sẵn mọi sự kiện tuỳ chỉnh mà bạn ghi lại 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ị 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 cả dữ liệu điền sẵn nhật ký đường dẫn.

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

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. Để người dùng có 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ã:

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. Cho phép thu thập đối với một số người dùng bằng cách gọi dữ liệu 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 để Crashlytics có thể tự động thu thập báo cáo. Để chọn không sử dụng tính năng báo cáo sự cố tự động, hãy 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);
   

Lưu ý: Khi tính năng thu thập dữ liệu bị tắt, Crashlytics sẽ lưu trữ thông tin về sự cố trên thiết bị. Nếu bạn bật tính năng thu thập dữ liệu sau đó, mọi thông tin 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 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ố.

Crash Insights sử dụng dữ liệu tổng hợp về sự cố để 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 từ trình đơn Thông tin chi tiết về sự cố ở đầu danh sách vấn đề của Crashlytics trong bảng điều khiển của 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á. Thay đổi có thể mất tới 24 giờ mới có hiệu lực.