Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Tùy chỉnh báo cáo sự cố Firebase Crashlytics của bạn

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Hướng dẫn này mô tả cách tùy chỉnh báo cáo sự cố của bạn bằng cách sử dụng API Crashlytics. Theo mặc định, Crashlytics tự động thu thập báo cáo sự cố dựa trên nền tảng cho tất cả người dùng ứng dụng của bạn (bạn cũng có thể tắt báo cáo sự cố tự động và bật báo cáo chọn tham gia cho người dùng của mình). Crashlytics cung cấp năm cơ chế ghi nhật ký: khóa tùy chỉnh, nhật ký tùy chỉnh , số nhận dạng người dùng , các ngoại lệ bị bắt và không cần thiết.

Đối với ứng dụng Flutter, các báo cáo nghiêm trọng được gửi đến Crashlytics trong 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 đượ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ệ không cần thiết

Bạn có thể tự động bắt tất cả các lỗi "nghiêm trọng" được đưa ra trong khuôn khổ Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError . Ngoài ra, để bắt các ngoại lệ "không gây tử vong", 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ộ

Khuôn khổ Flutter không bắt được lỗi không đồng bộ:

ElevatedButton(
  onPressed: () async {
    throw Error();
  }
  ...
)

Để bắt 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());

}

Các lỗi bên ngoài Flutter

Để bắt lỗi xảy ra bên ngoài ngữ cảnh Flutter, hãy cài đặt trình xử lý 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ệ bị bắt

Ngoài việc tự động báo cáo sự cố ứng dụng của bạn, Crashlytics cho phép bạn ghi lại các trường hợp ngoại lệ không nghiêm trọng và gửi chúng 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 ứng dụng của bạ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 có thể muốn ghi 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 sự cố không nghiêm trọng trong bảng điều khiển Firebase. Bản tóm tắt sự cố chứa tất cả thông tin trạng thái mà bạn thường nhận được từ sự cố, cùng với sự cố 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 chuỗi nền chuyên dụng để giảm thiểu tác động đến hiệu suất đối với ứng dụng của bạn. Để giảm lưu lượng truy cập mạng của người dùng, Crashlytics sẽ giới hạn tỷ lệ số lượng báo cáo được gửi khỏi thiết bị, nếu cần.

Thêm khóa tùy chỉnh

Khóa tùy chỉnh giúp bạn có đượ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 khóa / giá trị tùy ý với báo cáo sự cố của mình, sau đó sử dụng các khóa tùy 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 Crashlytics , bạn có thể tìm kiếm các vấn đề khớp với khóa tùy chỉnh.

  • Khi bạn đang xem xét một vấn đề cụ thể trong bảng điều khiển, bạn có thể xem các phím tùy chỉnh được liên kết cho từng sự kiện (tab phụ Phím ) và thậm chí lọc các sự kiện theo các phím tùy chỉnh (menu Bộ lọc ở đầu trang).

Sử dụng phương thức cá thể setCustomKey để đặt các cặp khóa / 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ý tùy chỉnh

Để có thêm ngữ cảnh cho các sự kiện dẫn đến sự cố, bạn có thể thêm nhật ký Crashlytics tùy chỉnh vào ứng dụng của mình. Crashlytics liên kết 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 Firebase , trong tab Nhật ký Crashlytics.

Sử dụng log để giúp xác định các vấn đề. Ví dụ:

FirebaseCrashlytics.instance.log("Higgs-Boson detected! Bailing out");

Đặt số nhận dạng người dùng

Để chẩn đoán sự cố, thường hữu ích khi biết người dùng nào của bạn gặp phải sự cố nhất định. Crashlytics bao gồm một cách để xác định ẩn danh người dùng trong báo cáo sự cố của bạn.

Để thêm ID 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 ở dạng số ID, mã thông báo hoặc giá trị băm:

FirebaseCrashlytics.instance.setUserIdentifier("12345");

Nếu bạn cần xóa số nhận dạng người dùng sau khi đặt, hãy đặt lại giá trị thành chuỗi trống. Xóa số nhận dạng người dùng không xóa các bản ghi Crashlytics hiện có. Nếu bạn cần xóa các bản ghi được liên kết với ID người dùng, hãy liên hệ với bộ phận hỗ trợ của Firebase .

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. Để cung cấp 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 tham gia bằng cách tắt 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 bộ sưu tập tự động nguyên bản:

    Nền tảng của Apple

    Thêm khóa mới vào tệp Info.plist của bạn:

    • Chìa khóa: 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 thu thập cho những người dùng được chọn bằng cách gọi ghi đè thu thập dữ liệu Crashlytics trong thời gian chạy.

    Giá trị ghi đè vẫn tồn tại qua các lần khởi chạy ứng dụng của bạn nên Crashlytics có thể tự động thu thập báo cáo. Để chọn không tham gia báo cáo sự cố tự động, hãy chuyển false làm giá trị ghi đè. Khi được đặ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 Crash Insights

Crash Insights 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 của bạn với các dấu vết từ các ứng dụng Firebase khác và cho bạn biết liệu sự cố của bạn có phải là một phần của 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.

Crash Insights sử dụng dữ liệu sự cố tổng hợp để xác định các xu hướng ổn định phổ biến. Nếu không muốn chia sẻ dữ liệu ứng dụng của mình, bạn có thể chọn không tham gia Crash Insights từ menu Crash Insights ở đầu danh sách sự cố Crashlytics trong bảng điều khiển Firebase .