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 của bạn bằng Firebase Crashlytics SDK để bạn có thể nhận được sự cố toàn diện trong bảng điều khiển của Firebase. Sử dụng Crashlytics cho Android, bạn sẽ nhận được báo cáo về sự cố, lỗi không nghiêm trọng và "Ứng dụng không phản hồi" Lỗi (ANR).

Để thiết lập Crashlytics, bạn cần thực hiện các thao tác cả trong bảng điều khiển của Firebase và IDE của bạn (như thêm tệp cấu hình Firebase và Crashlytics SDK). Để hoàn tất quá trình thiết lập, bạn cần xác định sự cố thử nghiệm để gửi báo cáo sự cố cho Firebase.

Trước khi bắt đầu

  1. Thêm Firebase vào thiết bị Android của bạn nếu bạn chưa thêm dự án. Nếu chưa có ứng dụng Android, bạn có thể tải xuống ứng dụng mẫu.

  2. Đề xuất: Để tự động nhận nhật ký breadcrumb (tập hợp liên kết phân cấp) để tìm hiểu 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 không có Google Analytics , bạn có thể bật Google Analytics từ Thẻ Tích hợp trong > Cài đặt dự án trong bảng điều khiển của 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.

  3. Đảm bảo ứng dụng của bạn có các phiên bản được yêu cầu tối thiểu sau đây:

    • Gradle 8.0
    • Trình bổ trợ Android cho Gradle 8.1.0
    • Trình bổ trợ Gradle cho các dịch vụ của Google 4.4.1

Bước 1: Thêm Crashlytics SDK vào ứng dụng của bạn

Trong tệp Gradle (cấp ứng dụng) của mô-đun (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm phần phụ thuộc cho thư viện Crashlytics cho Android. Bạn nên sử dụng Bảng kê khai thành phần của Firebase cho Android để kiểm soát việc tạo phiên bản thư viện.

Để tận dụng nhật ký breadcrumb (tập hợp liên kết phân cấp), bạn cũng có thể thêm Firebase SDK cho Google Analytics vào ứng dụng của mình. Đảm bảo rằng Google Analytics đang bật trong dự án Firebase của bạn.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.1.2"))

    // Add the dependencies for the Crashlytics and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics")
    implementation("com.google.firebase:firebase-analytics")
}

Bằng cách sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Android trên Firebase.

(Phương án thay thế) Thêm các phần phụ thuộc của thư viện Firebase mà không sử dụng BoM

Nếu chọn không sử dụng BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc.

Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự bạn nên sử dụng BoM để quản lý các phiên bản thư viện. Điều này đảm bảo rằng tất cả các phiên bản đều tương thích.

dependencies {
    // Add the dependencies for the Crashlytics and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics:19.0.3")
    implementation("com.google.firebase:firebase-analytics:22.0.2")
}
Bạn đang tìm một mô-đun thư viện dành riêng cho Kotlin? Bắt đầu sau Tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).

Bước 2: Thêm trình bổ trợ Crashlytics Gradle vào ứng dụng của bạn

  1. Trong tệp Gradle cấp gốc (cấp dự án) (<project>/build.gradle.kts hoặc <project>/build.gradle), hãy thêm Trình bổ trợ Crashlytics Gradle vào khối plugins:

    Kotlin

    plugins {
        // Make sure that you have the AGP plugin 8.1+ dependency
        id("com.android.application") version "8.1.4" apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
        id("com.google.gms.google-services") version "4.4.2" apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id("com.google.firebase.crashlytics") version "3.0.2" apply false
    }
    

    Groovy

    plugins {
        // Make sure that you have the AGP plugin 8.1+ dependency
        id 'com.android.application' version '8.1.4' apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
        id 'com.google.gms.google-services' version '4.4.2' apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id 'com.google.firebase.crashlytics' version '3.0.2' apply false
    }
    
  2. Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm trình bổ trợ Crashlytics Gradle:

    Kotlin

    plugins {
      id("com.android.application")
      // ...
    
      // Make sure that you have the Google services Gradle plugin
      id("com.google.gms.google-services")
    
      // Add the Crashlytics Gradle plugin
      id("com.google.firebase.crashlytics")
    }

    Groovy

    plugins {
      id 'com.android.application'
      // ...
    
      // Make sure that you have the Google services Gradle plugin
      id 'com.google.gms.google-services'
    
      // Add the Crashlytics Gradle plugin
      id 'com.google.firebase.crashlytics'
    }

Bước 3: Xác định sự cố thử nghiệm để hoàn tất quá trình thiết lập

Để hoàn tất việc thiết lập Crashlytics và xem dữ liệu ban đầu trong Trang tổng quan Crashlytics trong bảng điều khiển của Firebase, bạn cần buộc thử nghiệm sự cố.

  1. Thêm mã vào ứng dụng mà bạn có thể sử dụng để xác định sự cố kiểm thử.

    Bạn có thể sử dụng mã sau trong MainActivity của ứng dụng để thêm nút cho ứng dụng của bạn và khi được nhấn, sẽ gây ra sự cố. Nút này được gắn nhãn "Thử nghiệm sự cố".

    Kotlin+KTX

    val crashButton = Button(this)
    crashButton.text = "Test Crash"
    crashButton.setOnClickListener {
       throw RuntimeException("Test Crash") // Force a crash
    }
    
    addContentView(crashButton, ViewGroup.LayoutParams(
           ViewGroup.LayoutParams.MATCH_PARENT,
           ViewGroup.LayoutParams.WRAP_CONTENT))
    

    Java

    Button crashButton = new Button(this);
    crashButton.setText("Test Crash");
    crashButton.setOnClickListener(new View.OnClickListener() {
       public void onClick(View view) {
           throw new RuntimeException("Test Crash"); // Force a crash
       }
    });
    
    addContentView(crashButton, new ViewGroup.LayoutParams(
           ViewGroup.LayoutParams.MATCH_PARENT,
           ViewGroup.LayoutParams.WRAP_CONTENT));
    
  2. Tạo bản dựng và chạy ứng dụng của bạn.

  3. Buộc kiểm thử sự cố để gửi báo cáo sự cố đầu tiên cho ứng dụng của bạn:

    1. Mở ứng dụng của bạn từ thiết bị thử nghiệm hoặc trình mô phỏng.

    2. Trong ứng dụng của bạn, hãy nhấn vào nút "Test Crash" (Sự cố kiểm thử) mà bạn đã thêm bằng mã ở trên.

    3. Sau khi ứng dụng của bạn gặp sự cố, hãy khởi động lại ứng dụng để ứng dụng của bạn có thể gửi sự cố báo cáo cho Firebase.

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

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


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

Các bước tiếp theo

  • Tích hợp với Google Play để bạn có thể lọc trực tiếp các báo cáo sự cố của ứng dụng Android theo dõi trên Google Play trong Trang tổng quan Crashlytics. Điều này cho phép bạn tập trung tốt hơn vào trang tổng quan của mình vào các bản dựng cụ thể.
  • Trong Android Studio, hãy xem và lọc dữ liệu Crashlytics.
    • Sử dụng cửa sổ App Quality Insights (AQI) trong Android Studio để xem Crashlytics cùng với mã của bạn – không cần chuyển qua lại giữa Crashlytics trang tổng quan và IDE để bắt đầu gỡ lỗi các sự cố hàng đầu.
    • Truy cập vào cửa sổ AQI trong bản phát hành Electric Eel (chính thức) của Android Studio hoặc dùng thử các tính năng mới của chỉ số AQI trong Flamingo (bản thử nghiệm). Tải phiên bản Android Studio mà bạn muốn xuống.
    • Học tập cách sử dụng cửa sổ AQI trong tài liệu của Android Studio.
    • Chúng tôi muốn nghe ý kiến của bạn! Gửi ý kiến phản hồi về khoảng thời gian chỉ số AQI cho chúng tôi chậm nhất gửi báo cáo lỗi.