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

Chọn nền tảng:

Hướng dẫn này mô tả cách bắt đầu sử dụng Firebase Crashlytics trong dự án Unity.

Sau khi thiết lập SDK Firebase Crashlytics trong ứng dụng, bạn có thể xem báo cáo sự cố toàn diện trong bảng điều khiển Firebase.

Để thiết lập Crashlytics, bạn cần thực hiện các tác vụ 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à 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ố đầu tiên đến Firebase.

Trước khi bắt đầu

Nếu bạn chưa thực hiện, hãy thêm Firebase vào dự án Unity. Nếu không có dự án Unity, bạn có thể tải xuống ứng dụng mẫu.
Nên làm: Để tự động nhận nhật ký dấu vết để 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 sự kiện ANR, bạn cần bật Google Analytics trong dự án Firebase.
- Nếu dự án Firebase hiện tại chưa bật Google Analytics đã bật, bạn có thể bật Google Analytics từ thẻ Tích hợp trong phần cài đặt > Cài đặt dự án trong bảng điều khiển của 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.

Bước 1: Thêm SDK Crashlytics vào ứng dụng

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

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

Để tận dụng nhật ký dấu vết hãy thêm Firebase SDK cho Google Analytics vào ứng dụng (FirebaseAnalytics.unitypackage). Đảm bảo rằng Google Analytics được bật trong dự án Firebase.

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 chạy 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 các ứ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 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+ của Crashlytics tự động bao gồm tính năng 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 biểu tượng hoá cho các sự cố thư viện gốc trong trang tổng quan Crashlytics, bạn phải tải thông tin biểu tượng lên vào thời gian xây dựng bằng Firebase CLI.

Để 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 đã cài đặt CLI, hãy nhớ cập nhật lên phiên bản mới nhất.

Bước 4: Tạo bản dựng dự án và tải 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 sang không gian làm việc Xcode.
Tạo bản dựng ứng dụng.

Đối với các nền tảng của Apple, trình bổ trợ Firebase Unity Editor 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 mỗi bản dựng.

Android

Trong hộp thoại Build Settings (Cài đặt bản dựng), hãy thực hiện một trong những thao tác sau:
- Xuất sang dự án Android Studio để tạo bản dựng dự án; hoặc
- Tạo bản dựng APK trực tiếp từ Unity Editor.
  Trước khi tạo bản dựng, hãy đảm bảo rằng hộp đánh dấu cho Create symbols.zip (Tạo symbols.zip) được đánh dấu 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 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:

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

FIREBASE_APP_ID: Mã ứng dụng Firebase Android (không phải tên gói)
Ví dụ về mã ứng dụng Firebase Android: 1:567383003300:android:17104a2ced0c9b9b
Bạn cần tìm mã ứng dụng Firebase?
Dưới đây là 2 cách để tìm mã ứng dụng Firebase:
- 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 mong muốn để tìm mã ứng dụng của ứng dụng đó.
PATH/TO/SYMBOLS: Đường dẫn đến tệp biểu tượng do CLI tạo
- Đã xuất sang 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 đã xuất sau khi bạn tạo bản dựng ứng dụng thông qua Gradle hoặc Android Studio.
- Đã tạo bản dựng 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 đã tạo trong thư mục gốc của dự án khi bản dựng của bạn 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 Firebase lệnh CLI cho việc tạo và tải tệp biểu tượng lê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 sử 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 Xin lưu ý rằng giá trị mặc định cho việc 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 đè để sử dụng Breakpad.
`--dry-run`	Tạo tệp biểu tượng nhưng không tải tệp đó lên Cờ này 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: 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 trên trang tổng quan Crashlytics trong bảng điều khiển của Firebase, bạn cần xác định 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ố thử nghiệm 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 cấu hình dự án Xcode của bạn để tải tệp biểu tượng lên.
- Android: Đối với các ứng dụng Android sử dụng IL2CPP, hãy chạy lệnh CLI crashlytics:symbols:upload để tải tệp biểu tượng lên.Firebase
Chạy ứng dụng. Sau khi ứng dụng đang chạy, hãy xem nhật ký thiết bị và đợi ngoại lệ kích hoạt từ CrashlyticsTester.
- iOS+: Xem nhật ký ở ngăn dưới cùng của Xcode.
- Android: Xem nhật ký bằng cách chạy lệnh sau trong thiết bị đầu cuối: adb logcat.
Chuyển đến trang tổng quan Crashlytics của Firebase bảng điều khiển để xem sự cố thử nghiệm.

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

Vậy là xong! Crashlytics hiện đang giám sát ứng dụng của bạn để phát hiện sự cố. Hãy 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ác bước tiếp theo

(Nên làm) Đối với các ứng dụng Android sử dụng IL2CPP, hãy nhận trợ giúp gỡ lỗi các sự cố do lỗi bộ nhớ gốc gây ra bằng cách thu thập báo cáo GWP-ASan. Các lỗi liên quan đến bộ nhớ này có thể liên quan đến việc hỏng bộ nhớ trong ứng dụng, đây là nguyên nhân hàng đầu gây ra các lỗ hổng bảo mật của ứ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 cho Unity (phiên bản 10.7.0 trở lên) và đã bật rõ ràng GWP-ASan (bạn cần 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 tham gia, nhật ký, khoá và theo dõi các lỗi không nghiêm trọng.
Xuất dữ liệu sang BigQuery hoặc Cloud Logging để phân tích và sử dụng các tính năng nâng cao, chẳng hạn như truy vấn dữ liệu, tạo trang tổng quan tuỳ chỉnh và thiết lập cảnh báo tuỳ chỉnh.