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ợ Crashlytics Flutter để bạn có thể nhận đượ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 cả việc sử dụng 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 một ngoại lệ thử nghiệm được gửi để gửi báo cáo sự cố đầu tiên đến Firebase.

Trước khi bắt đầu

  1. Nếu chưa thực hiện, hãy định cấu hình và khởi động Firebase trong dự án Flutter của bạn.

  2. Đề xuất: Để tự động nhận nhật ký đường dẫn nhằm hiểu rõ các hành động của người dùng dẫn đến sự kiện gặp sự cố, không nghiêm trọng hoặc 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 trong 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 một 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ý đường dẫn chỉ có trên 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 của bạn

  1. Từ 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 cả trình bổ trợ Flutter cho Google Analytics vào ứng dụng của bạn. Đảm bảo rằng 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 mới nhất và đối với Android, lệnh này sẽ thêm trình bổ trợ Gradle Crashlytics cần thiết 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à không bắt buộc, cũng có thể là cờ --obfuscate), thì 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 của mình.

    • 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à Crashlytics trình bổ trợ Flutter 3.3.4 trở lên) để dự án có thể tự động tạo và tải các 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 biểu tượng gỡ lỗi Flutter lên. Bạn cần tải biểu tượng gỡ lỗi lên trước khi báo cáo sự cố từ bản dựng mã nguồn bị làm rối.

      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 Firebase cho Android (không phải tên gói)
        Ví dụ về mã ứng dụng Firebase cho Android: 1:567383003300:android:17104a2ced0c9b9b

      • PATH/TO/symbols: Cùng một thư mục mà bạn truyền đến 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ả các lỗi phát sinh 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 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 phần Tuỳ chỉnh báo cáo sự cố.

Bước 3: Xác định 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 một ngoại lệ thử nghiệm được gửi đi.

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

    Nếu đã thêm một 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ể dùng mã sau để thêm một nút vào ứng dụng. Khi nhấn 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 của bạn.

  3. Buộc hệ thống đưa ra 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 Crashlytics trang tổng quan của bảng điều khiển Firebase để xem sự cố trong quá trình kiểm thử.

    Nếu bạn đã làm mới bảng điều khiển nhưng 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 để phát hiện sự cố và trên Android, các lỗi không nghiêm trọng và lỗi ANR. Truy cập vào trang tổng quan Crashlytics để xem và tìm hiểu tất cả báo cáo cũng như số liệu thống kê của bạn.

Các bước tiếp theo