Bắt đầu sử dụng Firebase Crashlytics


Hướng dẫn bắt đầu nhanh này mô tả cách thiết lập Firebase Crashlytics trong ứng dụng bằng trình bổ trợ Flutter Crashlytics để bạn có thể nhận các báo cáo toàn diện về sự cố trong bảng điều khiển Firebase.

Việc thiết lập Crashlytics bao gồm việc sử dụng cả công cụ dòng lệnh và IDE. Để hoàn tất quá trình thiết lập, bạn cần buộc gửi một ngoại lệ kiểm thử để gửi báo cáo sự cố đầu tiên đến Firebase.

Trước khi bắt đầu

  1. Định cấu hình và khởi chạy Firebase trong dự án Flutter của bạn (nếu bạn chưa thực hiện việc này).

  2. Đề xuất: Để tự động lấy nhật ký breadcrumb để hiểu những 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, bạn cần bật Google Analytics trong dự án Firebase của mình.

    • Nếu dự án Firebase hiện tại của bạn chưa bật Google Analytics, bạn có thể bật Google Analytics từ thẻ Tích hợp của > Cài đặt dự án trong bảng điều khiển Firebase.

    • Nếu bạn đang tạo dự án Firebase mới, hãy bật Google Analytics trong quy trình tạo dự án.

    Xin lưu ý rằng nhật ký chuỗi khối có sẵn cho tất cả các nền tảng Android và Apple mà Crashlytics hỗ trợ (ngoại trừ watchOS).

Bước 1: Thêm Crashlytics vào dự án Flutter

  1. Từ thư mục gốc của dự án Flutter, hãy chạy lệnh sau để cài đặt trình bổ trợ Flutter cho Crashlytics.

    Để tận dụng nhật ký đường dẫn, hãy thêm trình bổ trợ Flutter cho Google Analytics vào ứng dụng của bạn. Đảm bảo bạn đã bật Google Analytics trong dự án Firebase.

    flutter pub add firebase_crashlytics && flutter pub add firebase_analytics

  2. Trong thư mục gốc của dự án Flutter, hãy chạy lệnh sau:

    flutterfire configure

    Việc chạy lệnh này đảm bảo rằng cấu hình Firebase của ứng dụng Flutter luôn được cập nhật và đối với Android, sẽ thêm trình bổ trợ Crashlytics Gradle bắt buộc vào ứng dụng của bạn.

  3. Sau khi hoàn tất, hãy tạo lại dự án Flutter:

    flutter run

  4. (Không bắt buộc) Nếu dự án Flutter của bạn sử dụng cờ --split-debug-info (và cờ --obfuscate nếu muốn), bạn cần thực hiện thêm các bước để hiển thị dấu vết ngăn xếp có thể đọc được cho ứng dụng.

    • Nền tảng Apple: Đảm bảo rằng dự án của bạn đang sử dụng cấu hình phiên bản được đề xuất (Flutter 3.12.0 trở lên và trình bổ trợ Flutter Crashlytics 3.3.4 trở lên) để dự án có thể tự động tạo và tải biểu tượng Flutter (tệp dSYM) lên Crashlytics.

    • Android: Sử dụng Firebase CLI (phiên bản 11.9.0 trở lên) để tải các biểu tượng gỡ lỗi Flutter lên. Bạn cần tải các biểu tượng gỡ lỗi lên trước khi báo cáo sự cố từ một bản dựng mã bị làm rối mã nguồn.

      Trong thư mục gốc của dự án Flutter, hãy chạy lệnh sau:

      firebase crashlytics:symbols:upload --app=FIREBASE_APP_ID PATH/TO/symbols

      • FIREBASE_APP_ID: Mã ứng dụng Android trên Firebase (không phải tên gói)
        Mã ứng dụng Android trên Firebase mẫu: 1:567383003300:android:17104a2ced0c9b9b

      • PATH/TO/symbols: Thư mục giống như thư mục bạn truyền vào cờ --split-debug-info khi tạo ứng dụng

Bước 2: Định cấu hình trình xử lý sự cố

Bạn có thể tự động phát hiện tất cả lỗi được gửi trong khung Flutter bằng cách ghi đè FlutterError.onError bằng FirebaseCrashlytics.instance.recordFlutterFatalError:

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();

  // Pass all uncaught "fatal" errors from the framework to Crashlytics
  FlutterError.onError = FirebaseCrashlytics.instance.recordFlutterFatalError;

  runApp(MyApp());
}

Để phát hiện các lỗi không đồng bộ mà khung Flutter không xử lý, hãy sử dụng 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());

}

Để biết ví dụ về cách xử lý các loại lỗi khác, hãy xem bài viết Tuỳ chỉnh báo cáo sự cố.

Bước 3: Buộc sự cố thử nghiệm để hoàn tất việc thiết lập

Để hoàn tất việc thiết lập Crashlytics và xem dữ liệu ban đầu trên trang tổng quan Crashlytics của bảng điều khiển Firebase, bạn cần buộc gửi một ngoại lệ kiểm thử.

  1. Thêm mã vào ứng dụng mà bạn có thể dùng để buộc gửi một ngoại lệ kiểm thử.

    Nếu đã thêm trình xử lý lỗi gọi FirebaseCrashlytics.instance.recordError(error, stack, fatal: true) vào Zone cấp cao nhất, bạn có thể sử dụng mã sau để thêm một nút vào ứng dụng. Khi nhấn vào nút này, một ngoại lệ kiểm thử sẽ được gửi:

    TextButton(
    onPressed: () => throw Exception(),
    child: const Text("Throw Test Exception"),
),

  2. Tạo bản dựng và chạy ứng dụng.

  3. Buộc gửi trường hợp ngoại lệ kiểm thử để gửi báo cáo đầu tiên của ứng dụng:

    1. Mở ứng dụng trên thiết bị kiểm thử hoặc trình mô phỏng.

    2. Trong ứng dụng, hãy nhấn vào nút ngoại lệ kiểm thử mà bạn đã thêm bằng mã ở trên.

  4. Chuyển đến trang tổng quan Crashlytics của bảng điều khiển Firebase để xem sự cố kiểm thử.

    Nếu bạn đã làm mới bảng điều khiển và vẫn không thấy sự cố kiểm thử sau 5 phút, hãy bật tính năng ghi nhật ký gỡ lỗi để xem ứng dụng của bạn có gửi báo cáo sự cố hay không.


Vậy là xong! Crashlytics hiện đang theo dõi ứng dụng của bạn để tìm các sự cố và các lỗi không nghiêm trọng và ANR (ứng dụng không phản hồi) trên Android. Truy cập vào trang tổng quan Crashlytics để xem và điều tra tất cả báo cáo và số liệu thống kê của bạn.

Các bước tiếp theo