התאמה אישית של דוחות הקריסה ב-Firebase Crashlytics

בלוח הבקרה של Crashlytics תוכלו ללחוץ על בעיה ולקבל דוח מפורט על האירוע. אתם יכולים להתאים אישית את הדוחות האלה כדי לעזור לכם להבין טוב יותר מה קורה באפליקציה ואת הנסיבות של האירועים שדווחו ל-Crashlytics.

• מוסיפים לאפליקציה כלים לתיעוד ביומן של מפתחות בהתאמה אישית, הודעות יומן בהתאמה אישית ומזהי משתמשים.

• מדווחים על חריגים אל Crashlytics.

• לקבל באופן אוטומטי יומני נתיב ניווט אם האפליקציה שלכם משתמשת ב-Firebase SDK ל-Google Analytics. היומנים האלה מאפשרים לכם לראות את הפעולות של המשתמשים שהובילו לאירוע שנאסף על ידי Crashlytics באפליקציה.

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

הוספת מקשים בהתאמה אישית

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

• במרכז הבקרה Crashlytics אפשר לחפש בעיות שתואמות למפתח מותאם אישית.
• כשבודקים בעיה ספציפית במסוף, אפשר לראות את המפתחות המותאמים אישית המשויכים לכל אירוע (כרטיסיית המשנה Keys) ואפילו לסנן את האירועים לפי מפתחות מותאמים אישית (תפריט Filter בחלק העליון של הדף).

משתמשים ב-method‏ setCustomValue כדי להגדיר צמדי מפתח/ערך. לדוגמה:

// Set int_key to 100.
Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set str_key to "hello".
Crashlytics.crashlytics().setCustomValue("hello", forKey: "str_key")

// Set int_key to 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set str_key to "hello".
[[FIRCrashlytics crashlytics] setCustomValue:@"hello" forKey:@"str_key"];

אפשר גם לשנות את הערך של מפתח קיים על ידי קריאה למפתח והגדרת ערך אחר. לדוגמה:

Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set int_key to 50 from 100.
Crashlytics.crashlytics().setCustomValue(50, forKey: "int_key")

[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set int_key to 50 from 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(50) forKey:@"int_key"];

כדי להוסיף צמדי מפתח/ערך בכמות גדולה, משתמשים בשיטה setCustomKeysAndValues עם NSDictionary כפרמטר היחיד:

let keysAndValues = [
                 "string key" : "string value",
                 "string key 2" : "string value 2",
                 "boolean key" : true,
                 "boolean key 2" : false,
                 "float key" : 1.01,
                 "float key 2" : 2.02
                ] as [String : Any]

Crashlytics.crashlytics().setCustomKeysAndValues(keysAndValues)

NSDictionary *keysAndValues =
    @{@"string key" : @"string value",
      @"string key 2" : @"string value 2",
      @"boolean key" : @(YES),
      @"boolean key 2" : @(NO),
      @"float key" : @(1.01),
      @"float key 2" : @(2.02)};

[[FIRCrashlytics crashlytics] setCustomKeysAndValues: keysAndValues];

הוספת הודעות יומן בהתאמה אישית

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

Crashlytics.crashlytics().log("Higgs-Boson detected! Bailing out…, \(attributesDict)")

Crashlytics.crashlytics().log(format: "%@, %@", arguments: getVaList(["Higgs-Boson detected! Bailing out…", attributesDict]))

[[FIRCrashlytics crashlytics] log:@"Simple string message"];

[[FIRCrashlytics crashlytics] logWithFormat:@"Higgs-Boson detected! Bailing out... %@", attributesDict];

[[FIRCrashlytics crashlytics] logWithFormat:@"Logging a variable argument list %@" arguments:va_list_arg];

הגדרת מזהים של משתמשים

כדי לאבחן בעיה, לרוב כדאי לדעת אילו מהמשתמשים נתקלו בקריסה מסוימת. Crashlytics כולל דרך לזהות משתמשים באופן אנונימי בדוחות על קריסות.

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

Crashlytics.crashlytics().setUserID("123456789")

[[FIRCrashlytics crashlytics] setUserID:@"123456789"];

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

דיווח על חריגים לא חמורים

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

אפשר לתעד חריגים לא חמורים על ידי הקלטת אובייקטים של NSError באמצעות השיטה recordError. recordError מתעד את סטאק הקריאות של השרשור באמצעות קריאה ל-[NSThread callStackReturnAddresses].

Crashlytics.crashlytics().record(error: error)

[[FIRCrashlytics crashlytics] recordError:error];

כשמשתמשים בשיטה recordError, חשוב להבין את המבנה של NSError ואת האופן שבו Crashlytics משתמש בנתונים כדי לקבץ תאונות. שימוש שגוי בשיטה recordError עלול לגרום להתנהגות בלתי צפויה, ויכול לגרום ל-Crashlytics להגביל את הדיווח על שגיאות ביומן של האפליקציה.

לאובייקט NSError יש שלושה ארגומנטים:

• domain: String
• code: Int
• userInfo: [AnyHashable : Any]? = nil

בניגוד לקריסות קטלניות, שמקובצות באמצעות ניתוח של נתיב סטאק, השגיאות ביומן מקובצות לפי domain ו-code. יש הבדל חשוב בין קריסות קטלניות לשגיאות שנרשמו ביומן. לדוגמה:

let userInfo = [
  NSLocalizedDescriptionKey: NSLocalizedString("The request failed.", comment: ""),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString("The response returned a 404.", comment: ""),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString("Does this page exist?", comment: ""),
  "ProductID": "123456",
  "View": "MainView"
]

let error = NSError.init(domain: NSCocoaErrorDomain,
                         code: -1001,
                         userInfo: userInfo)

NSDictionary *userInfo = @{
  NSLocalizedDescriptionKey: NSLocalizedString(@"The request failed.", nil),
  NSLocalizedFailureReasonErrorKey: NSLocalizedString(@"The response returned a 404.", nil),
  NSLocalizedRecoverySuggestionErrorKey: NSLocalizedString(@"Does this page exist?", nil),
  @"ProductID": @"123456",
  @"View": @"MainView",
};

NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain
                                     code:-1001
                                 userInfo:userInfo];

כשרושמים ביומן את השגיאה שלמעלה, נוצרת בעיה חדשה שמקובצת לפי NSSomeErrorDomain ו--1001. שגיאות נוספות שנרשמו ביומן שמשתמשות באותם ערכי דומיין וקודים מקובצות באותה בעיה. הנתונים שמכיל האובייקט userInfo מומרים לזוגות מפתח/ערך ומוצגים בקטע 'מפתחות/יומנים' בבעיה מסוימת.

יומנים ומפתחות בהתאמה אישית

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

שיקולי ביצועים

חשוב לזכור שהרשמה ביומן של NSError עשויה להיות יקרה למדי. בזמן ההפעלה, Crashlytics מתעד את סטאק הקריאות של השרשור הנוכחי באמצעות תהליך שנקרא ביטול סטאק. התהליך הזה יכול להיות מוגזם מבחינת מעבדים (CPU) ומבחינת קלט/פלט (I/O), במיוחד בארכיטקטורות שתומכות בביטול חבילות DWARF (arm64 ו-x86). בסיום הביטול, המידע נכתב בדיסק באופן סינכרוני. כך אפשר למנוע אובדן נתונים אם השורה הבאה תקרוס.

אפשר לבצע קריאה ל-API הזה בבטחה בשרשור רקע, אבל חשוב לזכור שהעברת הקריאה הזו לתור אחר גורמת לאובדן ההקשר של מעקב הסטאק הנוכחי.

מה לגבי NSExceptions?

ב-Crashlytics אין אפשרות לתעד ישירות ביומן את המופעים של NSException. באופן כללי, ממשקי ה-API של Cocoa ו-Cocoa Touch לא מוגנים מפני חריגות. כלומר, לשימוש ב-@catch יכולות להיות תופעות לוואי לא רצויות חמורות מאוד בתהליך, גם אם משתמשים בו בזהירות רבה. אסור להשתמש בביטויי @catch בקוד. אפשר לעיין במסמכי התיעוד של Apple בנושא.

התאמה אישית של דוחות הקריסות

אם האפליקציה פועלת בסביבה לא ילידית (כמו C++‎ או Unity), אפשר להשתמש ב-Exception Model API כדי לדווח על המטא-נתונים של קריסה בפורמט החריגה הילידי של האפליקציה. חריגות שדווחו מסומנות כחריגות לא קטלניות.

var  ex = ExceptionModel(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(symbol:"makeError", file:"handler.js", line:495),
  StackFrame(symbol:"then", file:"routes.js", line:102),
  StackFrame(symbol:"main", file:"app.js", line:12),
]

crashlytics.record(exceptionModel:ex)

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithSymbol:@"makeError" file:@"handler.js" line:495],
  [FIRStackFrame stackFrameWithSymbol:@"then" file:@"routes.js" line:102],
  [FIRStackFrame stackFrameWithSymbol:@"main" file:@"app.js" line:12],
];

[[FIRCrashlytics crashlytics] recordExceptionModel:model];

אפשר גם לאתחל מסגרות סטאק בהתאמה אישית רק עם כתובות:

var  ex = ExceptionModel.init(name:"FooException", reason:"There was a foo.")
ex.stackTrace = [
  StackFrame(address:0xfa12123),
  StackFrame(address:12412412),
  StackFrame(address:194129124),
]

crashlytics.record(exceptionModel:ex)

FIRExceptionModel *model =
    [FIRExceptionModel exceptionModelWithName:@"FooException" reason:@"There was a foo."];
model.stackTrace = @[
  [FIRStackFrame stackFrameWithAddress:0xfa12123],
  [FIRStackFrame stackFrameWithAddress:12412412],
  [FIRStackFrame stackFrameWithAddress:194129124],
];


[[FIRCrashlytics crashlytics] recordExceptionModel:model];

אחזור יומני נתיבי ניווט

יומני נתיבי ניווט עוזרים להבין טוב יותר את האינטראקציות שהיו למשתמש עם האפליקציה שהובילו לקריסה, לאירוע לא קטלני או ל-ANR. היומנים האלה יכולים להיות מועילים כשמנסים לשחזר בעיה ולנפות באגים בה.

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

ה-SDK Analytics מתעד באופן אוטומטי את האירוע screen_view, וכך מאפשר ביומני המיקום להציג רשימה של מסכים שנצפו לפני הקריסה, האירוע הלא חמור או ה-ANR. יומן של נתיב breadcrumbs מסוג screen_view מכיל פרמטר firebase_screen_class.

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

לתשומת ליבכם: אתם יכולים לשלוט באיסוף ובשימוש בנתוני Google Analytics, כולל הנתונים שמאכלסים את יומני הלחם.

הפעלת דיווח על הסכמה

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

1. כדי להשבית את האיסוף האוטומטי, מוסיפים מפתח חדש לקובץ Info.plist:

   • מקש: FirebaseCrashlyticsCollectionEnabled
   • ערך: false

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

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

   Swift

   Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

   Objective-C

   [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

ניהול הנתונים של תובנות לגבי קריסות

התכונה 'תובנות לגבי קריסות' עוזרת לכם לפתור בעיות על ידי השוואה של עקבות ה-stack האנונימיים שלכם לעקבות מאפליקציות אחרות ב-Firebase, ומציינת אם הבעיה היא חלק ממגמה רחבה יותר. לגבי בעיות רבות, התכונה 'תובנות לגבי קריסות' מספקת גם מקורות מידע שיעזרו לכם לנפות את הבאגים שגרמו לקריסה.

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