איך מתחילים להשתמש ב-Crashlytics ל-Unity

בחירת פלטפורמה: iOS+‎ Android Android NDK Flutter Unity


במדריך הזה מוסבר איך להתחיל להשתמש ב-Firebase Crashlytics בפרויקט ב-Unity.

אחרי שמגדירים את ה-SDK של Firebase Crashlytics באפליקציה, אפשר לקבל דוחות קריסה מקיפים במסוף Firebase.

כדי להגדיר את Crashlytics, צריך לבצע משימות גם במסוף Firebase וגם ב-IDE (כמו הוספת קובץ תצורה של Firebase ו-SDK של Crashlytics). כדי לסיים את ההגדרה, צריך לאלץ קריסת בדיקה כדי לשלוח את דוח הקריסה הראשון ל-Firebase.

לפני שמתחילים

  1. אם עדיין לא הוספתם את Firebase לפרויקט Unity, אתם צריכים להוסיף אותו. אם אין לכם פרויקט ב-Unity, אתם יכולים להוריד אפליקציה לדוגמה.

  2. מומלץ: כדי לקבל באופן אוטומטי יומני פעולות משתמש שיעזרו לכם להבין את פעולות המשתמשים שהובילו לאירוע קריסה, לאירוע לא קריטי או לאירוע ANR, אתם צריכים להפעיל את Google Analytics בפרויקט Firebase.

    • אם אתם יוצרים פרויקט חדש ב-Firebase, זכרו להפעיל את Google Analytics לפני שתסיימו ליצור את הפרויקט.

    • אם אתם משתמשים בפרויקט קיים ב-Firebase שלא הפעלתם בו את Google Analytics, אתם יכולים להפעיל אותו בדף הגדרות > שילובים במסוף Firebase.

שלב 1: מוסיפים את ה-SDK של Crashlytics לאפליקציה

שימו לב: יכול להיות שכבר הורדתם את ה-SDK של Firebase Unity והוספתם את החבילות שמתוארות בשלבים הבאים כשביצעתם את הרישום של פרויקט Unity בפרויקט Firebase.

  1. מורידים את Firebase Unity SDK, ואז מחלצים את קובצי ה-SDK למיקום נוח. ערכת ה-SDK של Firebase Unity לא ספציפית לפלטפורמה.

  2. בפרויקט Unity הפתוח, עוברים אל Assets (נכסים) > Import Package (ייבוא חבילה) > Custom Package (חבילה בהתאמה אישית).

  3. מתוך קובץ ה-SDK שחילצתם, בוחרים לייבא את ה-SDK של Crashlytics (FirebaseCrashlytics.unitypackage).

    כדי להשתמש ביומני פעולות משתמש, צריך להוסיף לאפליקציה גם את Firebase SDK for Google Analytics (FirebaseAnalytics.unitypackage). חשוב לוודא שGoogle Analytics מופעל בפרויקט Firebase.

  4. בחלון Import Unity Package, לוחצים על Import.

שלב 2: הפעלה של Crashlytics

  1. יוצרים סקריפט חדש ב-C# ‎ ומוסיפים אותו ל-GameObject בסצנה.

    1. פותחים את הסצנה הראשונה ויוצרים GameObject ריק בשם CrashlyticsInitializer.

    2. לוחצים על Add Component (הוספת רכיב) ב-Inspector (כלי הבדיקה) של האובייקט החדש.

    3. בוחרים את הסקריפט של CrashlyticsInit כדי להוסיף אותו לאובייקט CrashlyticsInitializer.

  2. מאתחלים את Crashlytics ב-method‏ Start של הסקריפט:

    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()
    // ...
}

שלב 3: (Android בלבד) הגדרת העלאת סמלים

השלב הזה נדרש רק באפליקציות ל-Android שמשתמשות ב-IL2CPP.

  • באפליקציות ל-Android שמשתמשות בקצה העורפי של סקריפטים ב-Mono של Unity, אין צורך לבצע את השלבים האלה.

  • באפליקציות לפלטפורמות של אפל, לא צריך לבצע את השלבים האלה כי הפלאגין של Firebase Unity Editor מגדיר באופן אוטומטי את פרויקט Xcode להעלאת סמלים.

ערכת ה-SDK של Crashlytics ל-Unity (גרסה 8.6.1 ואילך) כוללת באופן אוטומטי דיווח על קריסות של NDK, שמאפשר ל-Crashlytics לדווח באופן אוטומטי על קריסות של IL2CPP ב-Unity ב-Android. עם זאת, כדי לראות דוחות קריסה עם סמלים של קריסות בספריית Native במרכז הבקרה של Crashlytics, צריך להעלות את פרטי הסמלים בזמן ה-build באמצעות ה-CLI של Firebase.

כדי להגדיר העלאת סמלים, פועלים לפי ההוראות להתקנת ה-CLI של Firebase.

אם כבר התקנתם את ה-CLI, ודאו שעדכנתם אותו לגרסה העדכנית.

שלב 4: בניית הפרויקט והעלאת סמלים

‫iOS+‎ (הפלטפורמה של Apple)

  1. בתיבת הדו-שיח Build Settings, מייצאים את הפרויקט לסביבת עבודה של Xcode.

  2. יוצרים את האפליקציה.

    בפלטפורמות של אפל, הפלאגין של Firebase Unity Editor מגדיר באופן אוטומטי את פרויקט Xcode כך שייצור קובץ סמלים שתואם ל-Crashlytics ויעלה אותו לשרתי Firebase בכל גרסה.

Android

  1. בתיבת הדו-שיח Build Settings, מבצעים אחת מהפעולות הבאות:

    • לייצא לפרויקט ב-Android Studio כדי ליצור את הפרויקט.

    • יוצרים את ה-APK ישירות מ-Unity Editor.
      לפני שיוצרים את ה-build, צריך לוודא שתיבת הסימון Create symbols.zip מסומנת בתיבת הדו-שיח Build Settings.

  2. אחרי שה-build מסתיים, יוצרים קובץ סמלים שתואם ל-Crashlytics ומעלים אותו לשרתי Firebase באמצעות הפקודה הבאה ב-CLI של Firebase:

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

    • FIREBASE_APP_ID: מזהה אפליקציית Android שלכם ב-Firebase (לא שם החבילה)
      דוגמה למזהה אפליקציית Android ב-Firebase: ‏1:567383003300:android:17104a2ced0c9b9b

    • ‫PATH/TO/SYMBOLS: הנתיב לקובץ הסמלים שנוצר על ידי ה-CLI

      • ייצוא לפרויקט Android Studio – ‏PATH/TO/SYMBOLS היא הספרייה unityLibrary/symbols, שנוצרת בתיקיית השורש של הפרויקט שיוצא אחרי שיוצרים את האפליקציה באמצעות Gradle או Android Studio.

      • יצרתם את ה-APK ישירות מתוך Unity – PATH/TO/SYMBOLS הוא הנתיב של קובץ הסמלים הדחוס שנוצר בספריית השורש של הפרויקט כשה-build הסתיים (לדוגמה: myproject/myapp-1.0-v100.symbols.zip).

    אפשרויות מתקדמות לשימוש בפקודת ה-CLI של Firebase ליצירה ולהעלאה של קובץ סמלים

    דיווח תיאור
    --generator=csym

    שימוש במחולל קובצי הסמלים cSYM מדור קודם במקום במחולל ברירת המחדל של Breakpad

    לא מומלץ לשימוש. אנחנו ממליצים להשתמש במחולל קובצי הסמלים של Breakpad שמוגדר כברירת מחדל.

    --generator=breakpad

    שימוש במחולל קובצי הסמלים של Breakpad

    שימו לב שברירת המחדל ליצירת קובץ סמלים היא Breakpad. השתמשו בדגל הזה רק אם הוספתם את symbolGenerator { csym() } בתצורת ה-build ואתם רוצים לשנות אותה כדי להשתמש ב-Breakpad במקום זאת.

    --dry-run

    יצירת קובצי הסמלים בלי להעלות אותם

    הדגל הזה שימושי אם רוצים לבדוק את התוכן של הקבצים שנשלחים.

    --debug מספק מידע נוסף על תוצאות ניפוי הבאגים

שלב 5: אילוץ קריסה לבדיקה כדי לסיים את ההגדרה

כדי לסיים את ההגדרה של Crashlytics ולראות נתונים ראשוניים במרכז הבקרה של Crashlytics במסוף Firebase, צריך לאלץ קריסה לבדיקה.

  1. מוצאים GameObject קיים ומוסיפים לו את הסקריפט הבא. הסקריפט הזה יגרום לקריסה לבדיקה כמה שניות אחרי הפעלת האפליקציה.

    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");
        }
    }
}

  2. יוצרים את האפליקציה ומעלים את פרטי הסמלים אחרי שה-build מסתיים.

    • ‫iOS+: הפלאגין Firebase Unity Editor מגדיר באופן אוטומטי את פרויקט Xcode להעלאת קובץ הסמלים.

    • Android: באפליקציות ל-Android שמשתמשות ב-IL2CPP, מריצים את הפקודה Firebase ב-CLI crashlytics:symbols:upload כדי להעלות את קובץ הסמלים.

  3. מפעילים את האפליקציה. כשהאפליקציה פועלת, עוקבים אחרי קובץ היומן במכשיר ומחכים שהחריגה תופעל מ-CrashlyticsTester.

    • ‫iOS+‎: הצגת היומנים בחלונית התחתונה של Xcode.

    • ‫Android: כדי לראות את היומנים, מריצים את הפקודה הבאה בטרמינל: adb logcat.

  4. במסוף Firebase, נכנסים לדף DevOps & Engagement (DevOps ומעורבות) > לוח הבקרה של Crashlytics כדי לבדוק את דוח הקריסה לבדיקה.

    אם רעננתם את המסוף ואתם עדיין לא רואים את הקריסה לבדיקה אחרי חמש דקות, הפעילו את יומן ניפוי הבאגים כדי לבדוק אם האפליקציה שולחת דוחות קריסה.


זה הכול! עכשיו Crashlytics עוקב אחרי קריסות באפליקציה שלך. בלוח הבקרה של Crashlytics אפשר לראות את כל הדוחות והנתונים הסטטיסטיים ולחקור אותם.

השלבים הבאים