自訂 Firebase Crashlytics 當機報告

在 Crashlytics 資訊主頁中，您可以查看問題並取得詳細的事件報表。您可以自訂這些報表，進一步瞭解應用程式的動態，以及向 Crashlytics 回報事件的情況。

  • 如果您的應用程式使用 Google Analytics (分析) 專用 Firebase SDK，系統會自動取得導覽標記記錄。這些記錄檔可讓您瞭解導致應用程式中產生 Crashlytics 收集事件的使用者動作。

  • 關閉自動當機回報功能，並為使用者啟用回報功能。請注意，根據預設，Crashlytics 會自動收集應用程式所有使用者的當機報告。

新增自訂鍵

你可以使用自訂鍵，取得導致當機情況的應用程式特定狀態。您可以將任意鍵/值組合與當機報告建立關聯，然後在 Firebase 控制台中使用自訂鍵搜尋及篩選當機報告。

  • 您可以在 Crashlytics 資訊主頁中搜尋符合自訂鍵的問題。
  • 在主控台中查看特定問題時，您可以查看每個事件相關聯的自訂鍵 (「金鑰」子分頁)，甚至可依自訂鍵篩選事件 (頁面頂端的「篩選器」選單)。

請使用 setCustomValue 方法設定鍵/值組合。例如：

Swift 

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

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

目標-C

設定整數、布林值或浮點數時，請將值方塊設為 @(value)。

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

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

您也可以呼叫鍵並設為不同的值，藉此修改現有鍵的值。例如：

Swift 

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

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

目標-C

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

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

使用 setCustomKeysAndValues 方法，並將 NSDictionary 做為唯一參數，大量新增鍵/值組合：

Swift 

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)

目標-C

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 會將這些記錄與當機資料建立關聯，並顯示在 Firebase 控制台的 Crashlytics 頁面中，「記錄」分頁下方。

Swift

使用log()或log(format:, arguments:)協助找出問題。如要取得內含訊息的實用記錄輸出內容，您傳遞至 log() 的物件必須符合 CustomStringConvertible 屬性。log() 會傳回您為物件定義的說明屬性。例如：

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

呼叫 getVaList() 後傳回的 .log(format:, arguments:) 值格式。例如：

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

如要進一步瞭解如何使用 log() 或 log(format:, arguments:)，請參閱 Crashlytics 參考說明文件。

目標-C

使用log或logWithFormat協助找出問題。請注意，如要取得內含訊息的實用記錄輸出，傳遞至任一方法的物件必須覆寫 description 執行個體屬性。例如：

[[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];

如要進一步瞭解如何使用 log 和 logWithFormat，請參閱 Crashlytics 參考說明文件。

設定使用者 ID

如要診斷問題，瞭解哪些使用者遇到了特定當機問題，通常會很有幫助。Crashlytics 可讓您在當機報告中以匿名方式識別使用者。

如要在報表中加入使用者 ID，請以 ID 號碼、權杖或雜湊值的形式，為每位使用者指派專屬 ID：

Swift 

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

目標-C

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

如果您在設定使用者 ID 之後需要清除，請將值重設為空白字串。清除使用者 ID 並不會移除現有的 Crashlytics 記錄。如果您需要刪除與使用者 ID 相關聯的記錄，請與 Firebase 支援團隊聯絡。

回報不嚴重的例外狀況

除了自動回報應用程式的當機問題外，Crashlytics 也能讓您記錄不嚴重的例外狀況，並在下次應用程式啟動時傳送這些例外狀況給您。

您可以使用 recordError 方法記錄 NSError 物件，記錄不嚴重的例外狀況。recordError 會呼叫 [NSThread callStackReturnAddresses] 擷取執行緒的呼叫堆疊。

Swift 

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

目標-C

[[FIRCrashlytics crashlytics] recordError:error];

使用 recordError 方法時，請務必瞭解 NSError 結構，以及 Crashlytics 如何使用資料將當機事件分組。不當使用 recordError 方法可能會導致無法預測的行為，並可能導致 Crashlytics 限制應用程式的已記錄錯誤回報功能。

NSError 物件有三個引數：

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

與嚴重當機事件不同，後者是以堆疊追蹤分析為分組依據，記錄的錯誤會依 domain 和 code 分組。這是區分嚴重當機和已記錄錯誤的重要區別。例如：

Swift 

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)

目標-C

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 執行個體的機制。一般來說，Cocoa 和 Cocoa Touch API 並非例外狀況，這表示即使您使用 @catch，也難免會在程序中產生嚴重的意外副作用，即便使用了極端的醫療照護也一樣。請勿在程式碼中使用 @catch 陳述式。請參閱 Apple 說明文件的相關主題。

自訂堆疊追蹤

如果應用程式是在非原生環境中 (例如 C++ 或 Unity) 執行，您可以使用 Exception Model API，以應用程式原生例外狀況格式回報當機中繼資料。回報的例外狀況會標示為非嚴重錯誤。

Swift 

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)

目標-C

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];

也可以只使用地址來初始化自訂堆疊框架：

Swift 

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)

目標-C

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 (分析) 提供技術支援，因此如要取得導覽標記記錄，您需要為 Firebase 專案啟用 Google Analytics (分析)，並將 Google Analytics (分析) 專用 Firebase SDK 新增至應用程式。符合這些規定後，系統就會在您查看問題詳細資料時，自動將導覽標記記錄與事件資料一併納入「記錄」分頁中。

Analytics SDK 會自動記錄 screen_view 事件，讓導覽標記記錄顯示當機、一般或 ANR 事件發生前瀏覽的畫面清單。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)

    目標-C

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

管理當機深入分析資料

當機分析功能可將匿名堆疊追蹤與其他 Firebase 應用程式的追蹤記錄進行比較，讓您瞭解問題是否出在更大趨勢，進而解決問題。許多問題甚至會提供相關資源來協助偵錯。

當機深入分析會使用匯總的當機資料，找出常見的穩定性趨勢。 如果您不想分享應用程式的資料，可以在 Firebase 控制台的 Crashlytics 問題清單頂端，從「Crash Insights」選單選擇不採用 Crash Insights。