自定义 Firebase Crashlytics 崩溃报告

本指南介绍如何使用 Firebase Crashlytics SDK 自定义崩溃报告。默认情况下，Crashlytics 会自动为应用的所有用户收集崩溃报告（您也可以关闭自动崩溃报告，并为您的用户启用自选式报告）。Crashlytics 提供了四种日志记录机制：自定义键、自定义日志、用户标识符和捕获的异常。

报告异常

报告捕获到的异常

如果某些异常预期会发生，您可以让 Crashlytics SDK 将其报告为非严重事件。这些事件会记录在设备上，然后与下一份严重事件报告一起发送或者在最终用户重启游戏时发送。

您可以使用 C# 通过以下方法记录异常：

Crashlytics.LogException(Exception ex);

您可以在游戏的 try/catch 块中记录预期异常：

try {
    myMethodThatThrows();
} catch (Exception e) {
   Crashlytics.LogException(e);
   // handle your exception here!
}

报告未捕获的异常

对于不会让您的游戏崩溃的未捕获的异常（例如，游戏逻辑中未捕获的 C# 异常），您可以让 Crashlytics SDK 将其报告为严重事件，具体方法是，在 Unity 项目中初始化 Crashlytics 的地方将 Crashlytics.ReportUncaughtExceptionsAsFatal 属性设置为 true。这些事件会实时报告给 Crashlytics，而无需最终用户重启游戏。

将这些未捕获的异常报告为严重事件意味着它们会计入您的未遇到崩溃问题的用户统计信息，并计入疾速崩溃提醒。

请注意，原生代码崩溃始终会报告为严重事件。这些事件会记录在设备上，然后在最终用户重启游戏时一并发送。

void Start() {
    // Since there is no try-block surrounding this call, if an exception is thrown,
    // it is considered unexpected.
    // Setting `Crashlytics.ReportUncaughtExceptionsAsFatal = true`
    // will ensure that such cases are reported as fatals.
    thirdPartyMethodThatMayThrow();
}

添加自定义键

自定义键可以帮助您获取导致崩溃的应用特定状态。 您可以将任意键值对与您的崩溃报告相关联，然后使用自定义键在 Firebase 控制台中搜索和过滤崩溃报告。

  • 在 Crashlytics 信息中心内，您可以搜索与自定义键匹配的问题。
  • 当您在控制台中查看某个特定问题时，可以查看每个事件关联的自定义键（在“键”子标签中），甚至可以按自定义键过滤事件（使用页面顶部的“过滤条件”菜单）。

如果调用了多次，将使用现有键的新值更新该值，并且在记录崩溃时系统仅会捕获最新值。

Crashlytics.SetCustomKey(string key, string value);

添加自定义日志消息

记录的消息与您的崩溃数据相关联，并在您查看特定崩溃时显示在 Firebase Crashlytics 信息中心中。

Crashlytics.Log(string message);

设置用户标识符

您可以使用 ID 编号、令牌或哈希值来唯一标识应用的最终用户，而无需披露或传输他们的任何个人信息。您也可以通过将相应值设置为空字符串来清除该值。当您查看特定崩溃时，该值将显示在 Firebase Crashlytics 信息中心中。

Crashlytics.SetUserId(string identifier);

启用自选式报告

默认情况下，Crashlytics 会自动为应用的所有用户收集崩溃报告。您可以让用户选择启用崩溃报告功能，从而让其对自己发送的数据有更多掌控权。

如需仅针对选定用户停用自动收集功能并初始化 Crashlytics，请在运行时调用 Crashlytics 数据收集替换。在您应用的多次启动之间，替换值会保持不变，因此 Crashlytics 可以自动收集相关报告。如需停用自动崩溃报告功能，请将 false 作为替换值传递。将此设置为 false 时，新值要等到应用下次运行时才会生效。

Crashlytics.IsCrashlyticsCollectionEnabled = true

管理 Crash Insights 数据

Crash Insights 会比较您的匿名堆栈轨迹和来自其他 Firebase 应用的轨迹，并让您知道您的问题是否属于个例，从而帮助您解决问题。对于许多问题，Crash Insights 甚至会提供资源来帮助您调试崩溃。

Crash Insights 使用汇总的崩溃数据来识别常见的稳定性趋势。 如果您不想分享应用的数据，则可以在 Crash Insights 菜单中选择停用 Crash Insights。此菜单位于 Firebase 控制台的 Crashlytics 问题列表顶部。