Tuỳ chỉnh báo cáo sự cố cho Flutter

Chọn nền tảng: iOS+ Android Flutter Unity


Bạn có thể nhấp vào một vấn đề và xem báo cáo chi tiết về sự kiện trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của Firebase bảng điều khiể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 các sự kiện được báo cáo cho Crashlytics.

Báo cáo ngoại lệ

Báo cáo 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 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ộ

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

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 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 ngoại lệ đã được xử lý

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

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 phát hiện 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 lại thêm thông tin về lỗi này 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 các vấn đề không nghiêm trọng trong trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase. 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 thông tin phân tích 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 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 số lượng báo cáo được gửi khỏi thiết bị, nếu cần.

Thêm khoá tuỳ chỉnh

Khoá tuỳ chỉnh giúp bạn nắm đượ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 trang tổng quan DevOps và mức độ tương tác > Crashlytics của bảng điều khiển Firebase.

  • Trong trang tổng quan, 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 trang tổng quan, 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 báo nhật ký tuỳ chỉnh

Để có thêm bối cảnh cho 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 các nhật ký với dữ liệu sự cố và hiển thị chúng trong thẻ Nhật ký khi bạn xem thông tin chi tiết về một vấn đề (xem tất cả các vấn đề trong trang tổng quan DevOps và mức độ tương tác > Crashlytics dashboard của bảng điều khiển Firebase).

Sử dụng log để giúp xác định chính xác 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 đề, bạn thường nên biết người dùng nào gặp phải sự cố cụ thể. 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ị được 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 đượ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ý 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 với ứng dụng của bạn dẫn đến sự cố, sự kiện 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 được cung cấp bởi Google Analytics. Vì vậy, để nhận 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 bạn. Sau khi đáp ứng các yêu cầu này, nhật ký breadcrumb sẽ tự động được thêm 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 đề (xem tất cả các vấn đề trong trang tổng quan DevOps và mức độ tương tác > Crashlytics bảng điều khiển của Firebase console).

SDK Analytics Analytics tự động ghi lại sự kiện screen_view cho phép nhật ký breadcrumb hiển thị danh sách các màn hình đã xem trước sự cố, sự kiện không nghiêm trọng hoặc sự kiện 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 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 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ự 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 dữ liệu, bao gồm cả dữ liệu điền sẵn nhật ký breadcrumb.

Bật tính năng 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. Để cho phép người dùng kiểm soát nhiều 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 gốc:

    Nền tảng Apple

    Thêm một 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 những người dùng đã chọn bằng cách gọi ghi đè tính năng thu thập dữ liệu Crashlytics Crashlytics trong thời gian chạy. Giá trị ghi đè vẫn tồn tại trên tất cả các lần khởi chạy tiếp theo của ứng dụng để 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 tham gia thu thập dữ liệu, bạn có thể truyền false làm giá trị ghi đè. Giá trị này sẽ được áp dụng vào lần tiếp theo khi người dùng khởi chạy ứng dụng và sẽ tồn tại trên tất cả các lần khởi chạy tiếp theo cho người dùng đó.

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 các vấn đề bằng cách so sánh các 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 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 đề, Thông tin chi tiết về sự cố thậm chí còn cung cấp các 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 ổn định chung. Nếu không muốn chia sẻ dữ liệu của ứng dụng, bạn có thể chọn không tham gia 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 đề trong DevOps và mức độ tương tác > Crashlytics trang tổng quan của Firebase bảng điều khiển.

Các bước tiếp theo