קבלת דוחות קריסה קריאים בלוח הבקרה של Crashlytics‏ (Flutter)

בחירת פלטפורמה:

‫iOS+‎ Android Flutter Unity

כברירת מחדל, Firebase Crashlytics מבצע אוטומטית אינסטרומנטציה בפרויקט Flutter כדי להעלות את קובצי הסמלים הנדרשים, וכך להבטיח שדוחות קריסה יהיו ברורים וקריאים.

לצערנו, יש מקרים שבהם הפרויקט לא מוגדר באופן מלא. במדריך הזה מוסבר מה האוטומציה עושה, ומוצגים השלבים הראשונים לניפוי באגים בהגדרת הפרויקט.

פלטפורמות של אפל

בדיקת ההגדרה להעלאת קובצי dSYM

הוספת הפלאגין Crashlytics Flutter והפעלת הפקודה flutterfire configure ינסו להוסיף סקריפט הפעלה לסביבת העבודה של פרויקט Xcode, שיאתר ויעלה את קובצי הסמלים dSYM הנדרשים אל Crashlytics. בלי הקבצים האלה, תופיע התראה 'חסר dSYM' בלוח הבקרה Crashlytics, והחריגים יוחזקו על ידי ה-Backend עד שהקבצים החסרים יועלו.

אם נתקלתם בבעיה הזו, קודם כל ודאו שהתקנתם את סקריפט ההרצה:

1. מאתרים ופותחים את קובץ סביבת העבודה של Xcode בספריית ה-iOS של הפרויקט (FLUTTER_PROJECT_NAME/ios/Runner.xcworkspace).

2. בודקים אם סקריפט הפעלה בשם [firebase_crashlytics] Crashlytics Upload Symbols נוסף לשלבי הבנייה של יעד ההפעלה.

   בהמשך מפורטות הוראות בהתאם למצב: סקריפט ההפעלה לא קיים או סקריפט ההפעלה קיים.

לא קיים סקריפט להעלאה אוטומטית של קובצי dSYM‏

אם הסקריפט הזה לא קיים, אפשר להוסיף אותו באופן ידני:

1. מאתרים את מזהה האפליקציה ב-Firebase של אפליקציית Apple. הנה שני מקומות שונים שבהם אפשר למצוא את המזהה הזה:

   • במסוף Firebase, עוברים אל > הגדרות הפרויקט. עוברים לכרטיס האפליקציות שלך ולוחצים על האפליקציה שלכם ל-Apple ב-Firebase כדי לראות את פרטי האפליקציה, כולל מזהה האפליקציה.

   • בספרייה ברמה העליונה של פרויקט Flutter, מחפשים את הקובץ firebase_options.dart. מזהה האפליקציה ב-Firebase של אפליקציית Apple מסומן בתווית appId.

2. לוחצים על > New Run Script Phase (שלב חדש של הפעלת תסריט).

   חשוב לוודא שהשלב החדש Run Script הוא שלב הבנייה האחרון בפרויקט. אחרת, לא ניתן לעבד את קובצי ה-dSYM בצורה תקינה.Crashlytics

3. מרחיבים את הקטע החדש Run Script.

   הערה: בשלבי המשנה הבאים, צריך להעתיק ולהדביק את הנתיבים בדיוק כמו שמופיע, ו-Xcode יפתור אותם. עם זאת, אם יש לכם בעיות ב-Xcode שקשורות לפתרון הנתיבים האלה או למבנה פרויקט ייחודי, אתם יכולים לציין את הנתיבים באופן ידני במקום זאת.

4. בשדה התסריט (שנמצא מתחת לתווית Shell), מוסיפים את התסריטים הבאים להרצה.

   הסקריפטים האלה מעבדים את קובצי ה-dSYM ומעלים אותם אל Crashlytics.

   $PODS_ROOT/FirebaseCrashlytics/upload-symbols --build-phase --validate -ai FIREBASE_APP_ID -- $DWARF_DSYM_FOLDER_PATH/App.framework.dSYM

   $PODS_ROOT/FirebaseCrashlytics/upload-symbols --build-phase -ai FIREBASE_APP_ID -- $DWARF_DSYM_FOLDER_PATH/App.framework.dSYM 

   • ‫FIREBASE_APP_ID: מזהה האפליקציה שלכם ב-Firebase ל-Apple (לא מזהה החבילה שלכם ב-Apple)
     דוגמה למזהה אפליקציה ב-Firebase ל-Apple: ‏ 1:1234567890:ios:321abc456def7890

   צריך למצוא את מזהה האפליקציה ב-Firebase?

   יש שתי דרכים למצוא את מזהה האפליקציה ב-Firebase:

   • בקובץ GoogleService-Info.plist, מזהה האפליקציה הוא הערך GOOGLE_APP_ID.

   • במסוף Firebase, עוברים אל Project settings. עוברים לכרטיס האפליקציות שלך ולוחצים על האפליקציה הרצויה ב-Firebase כדי למצוא את מזהה האפליקציה שלה.

5. בקטע Input Files, מוסיפים את הנתיבים למיקומים של הקבצים הבאים:

   ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}

   ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}

   ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist

   $(TARGET_BUILD_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist

   $(TARGET_BUILD_DIR)/$(EXECUTABLE_PATH)

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

   ‫Xcode מחפש את קובצי הקלט האלה במיקומים שצוינו כדי לוודא שקובצי ה-build זמינים לסקריפט ההרצה. בנוסף, אם האפשרות User Script Sandboxing מופעלת, Xcode מאפשרת לסקריפט ההרצה לגשת רק לקבצים שצוינו ב-Input Files.

   • אם תספקו את המיקום של קובצי ה-dSYM של הפרויקט,‏ Crashlytics יוכל לעבד את קובצי ה-dSYM.
   • ציון המיקום של קובץ ה-built של האפליקציה GoogleService-Info.plist מאפשר ל-Crashlytics לשייך את קובצי ה-dSYM לאפליקציה שלכם ב-Firebase.
   • ציון המיקום של קובץ ההפעלה של האפליקציה מאפשר לסקריפט ההרצה למנוע העלאות כפולות של אותו קובץ dSYM. חשוב לדעת שקבצים בינאריים של אפליקציות לא מועלים.

האם קיים סקריפט להעלאה אוטומטית של קובצי dSYM

אם קובץ ה-script של הריצה קיים, אפשר לעיין במדריך לפתרון בעיות ב-dSYM שספציפי ל-Apple. אם תבחרו להעלות את קובצי ה-dSYM באמצעות התהליך שמתואר כאן, תצטרכו לבצע את השלבים הנוספים הבאים:

1. מאתרים את מזהה האפליקציה ב-Firebase של אפליקציית Apple. הנה שני מקומות שונים שבהם אפשר למצוא את המזהה הזה:

   • במסוף Firebase, עוברים אל > הגדרות הפרויקט. עוברים לכרטיס האפליקציות שלך ולוחצים על האפליקציה שלכם ל-Apple ב-Firebase כדי לראות את פרטי האפליקציה, כולל מזהה האפליקציה.

   • בספרייה ברמה העליונה של פרויקט Flutter, מחפשים את הקובץ firebase_options.dart. מזהה האפליקציה ב-Firebase של אפליקציית Apple מסומן בתווית appId.

2. כשמריצים את הסקריפט upload-symbols, משתמשים ב--ai FIREBASE_APPLE_APP_ID במקום ב--gsp /path/to/GoogleService-Info.plist.

בודקים את הגדרת הגרסה של Flutter ושל Crashlytics (אם משתמשים בדגל --split-debug-info)

אם פרויקט Flutter שלכם משתמש בדגל --split-debug-info (ואפשר גם בדגל --obfuscate), צריך לבצע שלבים נוספים כדי להציג עקבות מחסנית קריאה קריאות באפליקציה.

חשוב לוודא שהפרויקט משתמש בהגדרת הגרסה המומלצת (Flutter 3.12.0 ומעלה וCrashlytics Flutter plugin 3.3.4 ומעלה) כדי שהפרויקט יוכל ליצור ולהעלות באופן אוטומטי סמלי Flutter (קבצי dSYM) אל Crashlytics.

Android

בדיקת הגדרות התלות

הפקודה flutterfire configure מנסה להוסיף את התלויות הנדרשות לקובצי ה-build של Gradle בפרויקט. אם התלות הזו לא קיימת, דוחות הקריסה במסוף Firebase עשויים להיות מעורפלים אם ההסתרה מופעלת.

מוודאים שהשורות הבאות מופיעות בקובץ build.gradle ברמת הפרויקט ובקובץ build.gradle ברמת האפליקציה:

• בקובץ ה-build ברמת הפרויקט (android/build.gradle), מחפשים את השורה הבאה:

  dependencies {
  // ... other dependencies
  
  classpath 'com.google.gms:google-services:4.3.5'
  classpath 'com.google.firebase:firebase-crashlytics-gradle:2.7.1'
  }

• בקובץ ה-build ברמת האפליקציה (android/app/build.gradle), מחפשים את השורה הבאה:

  // ... other imports
  
  android {
  // ... your android config
  }
  
  dependencies {
  // ... your dependencies
  }
  
  // This section must appear at the bottom of the file
  apply plugin: 'com.google.gms.google-services'
  apply plugin: 'com.google.firebase.crashlytics'

בודקים שאתם משתמשים ב-CLI כדי להעלות סמלים של Flutter (אם משתמשים בדגל --split-debug-info)

אם פרויקט Flutter שלכם משתמש בדגל --split-debug-info (ואפשר גם בדגל --obfuscate), צריך לבצע שלבים נוספים כדי להציג עקבות מחסנית קריאה קריאות באפליקציה.

משתמשים ב-Firebase CLI (גרסה 11.9.0 ואילך) כדי להעלות סמלי ניפוי באגים של Flutter. צריך להעלות את סמלי הניפוי באגים לפני שמדווחים על קריסה מגרסת build של קוד שעבר אובפוסקציה.

מתיקיית השורש של פרויקט Flutter, מריצים את הפקודה הבאה:

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

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

  צריך למצוא את מזהה האפליקציה ב-Firebase?

  יש שתי דרכים למצוא את מזהה האפליקציה ב-Firebase:

  • בקובץ google-services.json, מזהה האפליקציה הוא הערך mobilesdk_app_id.

  • במסוף Firebase, עוברים אל Project settings. עוברים לכרטיס האפליקציות שלך ולוחצים על האפליקציה הרצויה ב-Firebase כדי למצוא את מזהה האפליקציה שלה.

• ‫PATH/TO/symbols: אותה ספרייה שמעבירים לדגל --split-debug-info כשמבצעים build לאפליקציה

אם הבעיות נמשכות, אפשר לעיין במדריך לפתרון בעיות בדוחות שעברו טשטוש, שמתייחס ספציפית למערכת Android.