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

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

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

Trước khi bắt đầu

Thêm Firebase vào dự án Unity của bạn nếu bạn chưa thực hiện. Nếu chưa có dự án Unity, bạn có thể tải một ứng dụng mẫu xuống.
Đề xuất: Để tự động nhận nhật ký đường dẫn nhằm tìm hiểu các 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 lỗi 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 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.

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

Xin lưu ý rằng khi đăng ký dự án Unity bằng dự án Firebase, bạn có thể đã tải SDK Unity của Firebase xuống và thêm các gói được mô tả trong các bước sau.

Tải SDK Unity của Firebase xuống, sau đó giải nén SDK ở nơi thuận tiện. SDK Unity của Firebase không dành riêng cho nền tảng.
Trong dự án Unity đang mở, hãy chuyển đến Assets > Import Package > Custom Package (Thành phần > Nhập gói > Gói tuỳ chỉnh).
Trong SDK đã giải nén, hãy chọn để nhập SDK Crashlytics (FirebaseCrashlytics.unitypackage).

Để tận dụng nhật ký đường dẫn, bạn cũng nên thêm Firebase SDK cho Google Analytics vào ứng dụng của mình (FirebaseAnalytics.unitypackage). Hãy nhớ bật Google Analytics trong dự án Firebase của bạn.

Unity 2017.x trở lên cho phép sử dụng khung .NET 4.x. Nếu dự án Unity của bạn sử dụng .NET 4.x, hãy nhập dotnet4/FirebaseCrashlytics.unitypackage.
Trong cửa sổ Import Unity Package (Nhập gói Unity), hãy nhấp vào Import (Nhập).

Bước 2: Khởi chạy Crashlytics

Tạo một tập lệnh C# mới, sau đó thêm tập lệnh đó vào GameObject trong cảnh.
1. Mở cảnh đầu tiên, sau đó tạo một GameObject trống có tên là CrashlyticsInitializer.
2. Nhấp vào Add Component (Thêm thành phần) trong Inspector (Trình kiểm tra) cho đối tượng mới.
3. Chọn tập lệnh CrashlyticsInit để thêm tập lệnh đó vào đối tượng CrashlyticsInitializer.

Khởi động Crashlytics trong phương thức Start của tập lệnh:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

// Import Firebase and Crashlytics
using Firebase;
using Firebase.Crashlytics;

public class CrashlyticsInit : MonoBehaviour {
    // Use this for initialization
    void Start () {
        // Initialize Firebase
        Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
            var dependencyStatus = task.Result;
            if (dependencyStatus == Firebase.DependencyStatus.Available)
            {
                // Create and hold a reference to your FirebaseApp,
                // where app is a Firebase.FirebaseApp property of your application class.
                // Crashlytics will use the DefaultInstance, as well;
                // this ensures that Crashlytics is initialized.
                Firebase.FirebaseApp app = Firebase.FirebaseApp.DefaultInstance;

                // When this property is set to true, Crashlytics will report all
                // uncaught exceptions as fatal events. This is the recommended behavior.
                Crashlytics.ReportUncaughtExceptionsAsFatal = true;

                // Set a flag here for indicating that your project is ready to use Firebase.
            }
            else
            {
                UnityEngine.Debug.LogError(System.String.Format(
                  "Could not resolve all Firebase dependencies: {0}",dependencyStatus));
                // Firebase Unity SDK is not safe to use here.
            }
        });
    }

  // Update is called once per frame
  void Update()
    // ...
}

Bước 3: (Chỉ dành cho Android) Thiết lập để tải biểu tượng lên

Bước này chỉ bắt buộc đối với những ứng dụng Android sử dụng IL2CPP

Đối với các ứng dụng Android sử dụng phần phụ trợ tập lệnh Mono của Unity, bạn không cần thực hiện các bước này.
Đối với các ứng dụng nền tảng của Apple, bạn không cần thực hiện các bước này vì trình bổ trợ Firebase Unity Editor sẽ tự động định cấu hình dự án Xcode để tải biểu tượng lên.

SDK Unity 8.6.1 trở lên của Crashlytics tự động bao gồm báo cáo sự cố NDK, cho phép Crashlytics tự động báo cáo các sự cố IL2CPP của Unity trên Android. Tuy nhiên, để xem dấu vết ngăn xếp được thay thế bằng biểu tượng cho các sự cố xảy ra với thư viện gốc trên trang tổng quan Crashlytics, bạn phải tải thông tin về biểu tượng lên tại thời điểm xây dựng bằng cách sử dụng Giao diện dòng lệnh (CLI) của Firebase.

Để thiết lập tính năng tải biểu tượng lên, hãy làm theo hướng dẫn để cài đặt Firebase CLI.

Nếu bạn đã cài đặt CLI, hãy nhớ cập nhật lên phiên bản mới nhất.

Bước 4: Xây dựng dự án và tải các biểu tượng lên

iOS+ (nền tảng Apple)

Trong hộp thoại Build Settings (Cài đặt bản dựng), hãy xuất dự án của bạn sang không gian làm việc Xcode.
Tạo ứng dụng.

Đối với các nền tảng của Apple, trình bổ trợ Trình chỉnh sửa Unity của Firebase sẽ tự động định cấu hình dự án Xcode để tạo và tải tệp biểu tượng tương thích với Crashlytics lên máy chủ Firebase cho từng bản dựng.

Android

Trên hộp thoại Build Settings (Cài đặt bản dựng), hãy làm theo một trong những cách sau:
- Xuất sang một dự án Android Studio để tạo dự án; hoặc
- Tạo APK trực tiếp từ Trình chỉnh sửa Unity.
  Trước khi tạo, hãy nhớ đánh dấu vào hộp Create Shorts (Tạo ký hiệu.zip) trong hộp thoại Build Settings (Cài đặt bản dựng).

Sau khi bản dựng hoàn tất, hãy tạo một tệp biểu tượng tương thích với Crashlytics và tải tệp đó lên máy chủ Firebase bằng cách chạy lệnh Firebase CLI sau đây:

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

FIREBASE_APP_ID: Mã ứng dụng Android Firebase của bạn (không phải tên gói)
Mã ứng dụng Android Firebase mẫu: 1:567383003300:android:17104a2ced0c9b9b
Bạn cần tìm mã ứng dụng Firebase của mình?
Dưới đây là hai cách để tìm mã ứng dụng Firebase của bạn:
- Trong tệp google-services.json, mã ứng dụng của bạn là giá trị mobilesdk_app_id; hoặc
- Trong bảng điều khiển của Firebase, hãy chuyển đến phần Cài đặt dự án. Di chuyển xuống thẻ Ứng dụng của bạn, sau đó nhấp vào Ứng dụng Firebase mà bạn muốn tìm để tìm Mã ứng dụng.
PATH/TO/SYMBOLS: Đường dẫn đến tệp biểu tượng do CLI tạo
- Được xuất sang một dự án Android Studio – PATH/TO/SYMBOLS là thư mục unityLibrary/symbols, được tạo trong thư mục gốc của dự án được xuất sau khi bạn xây dựng ứng dụng thông qua Gradle hoặc Android Studio.
- Tạo APK trực tiếp từ trong Unity – PATH/TO/SYMBOLS là đường dẫn của tệp biểu tượng được nén được tạo trong thư mục gốc của dự án khi bản dựng hoàn tất (ví dụ: myproject/myapp-1.0-v100.symbols.zip).

Xem các tuỳ chọn nâng cao để sử dụng lệnh CLI Firebase để tạo và tải tệp biểu tượng lên

Gắn cờ	Nội dung mô tả
`--generator=csym`	Sử dụng trình tạo tệp biểu tượng cSYM cũ thay vì trình tạo Breakpad mặc định Không nên dùng. Bạn nên sử dụng trình tạo tệp biểu tượng Breakpad mặc định.
`--generator=breakpad`	Sử dụng trình tạo tệp biểu tượng Breakpad Lưu ý rằng giá trị mặc định để tạo tệp biểu tượng là Breakpad. Chỉ sử dụng cờ này nếu bạn đã thêm `symbolGenerator { csym() }` vào cấu hình bản dựng và muốn ghi đè lên đó để sử dụng Breakpad.
`--dry-run`	Tạo các tệp biểu tượng nhưng không tải chúng lên Cờ này sẽ hữu ích nếu bạn muốn kiểm tra nội dung của các tệp được gửi.
`--debug`	Cung cấp thông tin gỡ lỗi bổ sung

Bước 5: Buộc một 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 của bảng điều khiển của Firebase, bạn cần buộc xảy ra sự cố thử nghiệm.

Tìm một GameObject hiện có, sau đó thêm tập lệnh sau vào đó. Tập lệnh này sẽ gây ra sự cố kiểm thử vài giây sau khi bạn chạy ứng dụng.

using System;
using UnityEngine;

public class CrashlyticsTester : MonoBehaviour {

    int updatesBeforeException;

    // Use this for initialization
    void Start () {
      updatesBeforeException = 0;
    }

    // Update is called once per frame
    void Update()
    {
        // Call the exception-throwing method here so that it's run
        // every frame update
        throwExceptionEvery60Updates();
    }

    // A method that tests your Crashlytics implementation by throwing an
    // exception every 60 frame updates. You should see reports in the
    // Firebase console a few minutes after running your app with this method.
    void throwExceptionEvery60Updates()
    {
        if (updatesBeforeException > 0)
        {
            updatesBeforeException--;
        }
        else
        {
            // Set the counter to 60 updates
            updatesBeforeException = 60;

            // Throw an exception to test your Crashlytics implementation
            throw new System.Exception("test exception please ignore");
        }
    }
}

Tạo bản dựng ứng dụng và tải thông tin biểu tượng lên sau khi bản dựng hoàn tất.
- iOS+: Trình bổ trợ Firebase Unity Editor sẽ tự động định cấu hình dự án Xcode để tải tệp biểu tượng của bạn lên.
- Android: Đối với các ứng dụng Android sử dụng IL2CPP, hãy chạy lệnh Firebase CLI crashlytics:symbols:upload để tải tệp biểu tượng của bạn lên.
Chạy ứng dụng. Khi ứng dụng đang chạy, hãy xem nhật ký thiết bị và chờ ngoại lệ kích hoạt từ CrashlyticsTester.
- iOS+: Xem nhật ký trong ngăn dưới cùng của Xcode.
- Android: Xem nhật ký bằng cách chạy lệnh sau trong cửa sổ dòng lệnh: adb logcat.
Chuyển đến trang tổng quan của Crashlytics trong bảng điều khiển của Firebase để xem sự cố kiểm thử 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ố kiểm thử sau 5 phút, hãy bật tính năng ghi nhật ký gỡ lỗi để xem liệu ứng dụng 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 sự cố. Truy cập vào trang tổng quan Crashlytics để xem và tìm hiểu tất cả các báo cáo và số liệu thống kê của bạn.

Các bước tiếp theo

(Nên dùng) Đối với các ứng dụng Android sử dụng IL2CPP, bạn có thể nhận trợ giúp gỡ lỗi sự cố do lỗi bộ nhớ gốc bằng cách thu thập các báo cáo GWP-ASan. Những lỗi liên quan đến bộ nhớ này có thể liên quan đến tình trạng hỏng bộ nhớ trong ứng dụng của bạn. Đây là nguyên nhân hàng đầu gây ra các lỗ hổng bảo mật ứng dụng. Để tận dụng tính năng gỡ lỗi này, hãy đảm bảo ứng dụng của bạn sử dụng SDK Crashlytics mới nhất dành cho Unity (phiên bản 10.7.0 trở lên) và đã bật GWP-ASan một cách rõ ràng (yêu cầu bạn phải sửa đổi Tệp kê khai ứng dụng Android).

Tuỳ chỉnh chế độ thiết lập báo cáo sự cố bằng cách thêm tính năng báo cáo chọn sử dụng, nhật ký, khoá và theo dõi các lỗi không nghiêm trọng.

Tích hợp với Google Play để bạn có thể lọc báo cáo sự cố của ứng dụng Android theo kênh trên Google Play ngay trong trang tổng quan của Crashlytics. Nhờ đó, bạn có thể tập trung hiệu quả hơn vào trang tổng quan vào các bản dựng cụ thể.