跳转至正文

面向 Capacitor 应用的 Firebase Crashlytics

通过这份分步指南,学习如何为 iOS 和 Android 设置 Crashlytics,从而在移动应用中集成实时崩溃报告。

适用于 Capacitor 应用的 Firebase Crashlytics Capgo 博客插图

Firebase Crashlytics 能帮助你实时追踪应用崩溃,并提供详细报告以便快速修复问题。它能与以下工具无缝集成: Capacitor 适用于 iOS 和 Android 应用。以下是你需要了解的内容:

  • 为什么要使用 Crashlytics?

    • 获取 实时崩溃告警.
    • 使用以下功能分析详细崩溃报告: 自动问题分组.
    • 监控关键错误,确保应用稳定。
  • 环境要求:

    • 安装 Node.js (v16+), Capacitor (v4+),以及以下工具: Xcode 的 Mac 14+ 以及 Android Studio 中的错误日志 电鳗.
    • 下载 Firebase 配置文件 (GoogleService-Info.plist iOS 版, google-services.json Android 版)。
    • 更新平台特定文件,例如 Podfile (iOS) 和 build.gradle (Android)。
  • 关键步骤:

    • 安装 Crashlytics:

      npm install @capgo/capacitor-firebase-crashlytics && npx cap sync
    • 在应用中初始化 Crashlytics:

      import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';
      await FirebaseCrashlytics.initialize();
  • 测试你的配置:

    • 触发测试崩溃:

      await FirebaseCrashlytics.crash();
  • 额外提示: 将 Crashlytics 与 Capgo 实现即时 Live Update,无需等待应用商店审核。

本指南确保您的应用无崩溃且用户体验良好。立即开始配置 Firebase Crashlytics!

2021 年 Android 指南: Firebase Crashlytics - 自定义崩溃…

Firebase Crashlytics

设置要求

在开始之前,请确保您已完成以下步骤:

所需软件与账号

您需要安装以下内容:

  • Node.js (v16 或更高版本) 以及 Capacitor (v4 或更高版本)
  • 一套 Firebase 账号 拥有一个活跃项目
  • Xcode 14+ 用于 iOS 开发
  • Android Studio Electric Eel 或用于 Android 开发的更新版本
  • 最新版本的 CocoaPods (iOS 必需)

平台配置文件

iOS 端:

  • 从 Firebase Console 下载 GoogleService-Info.plist 文件。
  • 更新您的 Podfile 以包含 Crashlytics 依赖项。
  • 将必要的隐私权限键添加到你的 Info.plist 文件。

针对 Android:

  • 获取 google-services.json 文件。
  • 同时修改项目级和应用级的 build.gradle 文件。
  • 更新 AndroidManifest.xml 以包含所需的权限。

Firebase 控制台配置

Firebase 平台 Dashboard

按照以下步骤设置 Firebase 并启用 Crashlytics:

  1. 创建 Firebase 项目 并启用 Crashlytics。

  2. 注册您的应用 在 Firebase Console 中:

    • 使用 Bundle ID 用于 iOS,以及 包名 用于 Android。
    • 下载配置文件: GoogleService-Info.plist (iOS) 和 google-services.json (Android)。
  3. 集成 Firebase SDK 在应用中添加以下依赖项即可:

    Android(app 级 build.gradle):

    dependencies {
        implementation platform('com.google.firebase:firebase-bom:32.0.0')
        implementation 'com.google.firebase:firebase-crashlytics'
        implementation 'com.google.firebase:firebase-analytics'
    }

    iOS(Podfile):

    pod 'Firebase/Crashlytics'
    pod 'Firebase/Analytics'

完成上述步骤后,即可进入“插件安装”章节。

安装步骤

插件安装

然后,将插件同步到原生平台,并查看 @capgo/capacitor-firebase-crashlytics 插件页面以获取完整的 API 参考:

npm install @capgo/capacitor-firebase-crashlytics && npx cap sync

然后,在您的应用中初始化 Crashlytics。将以下 code 添加到 app.component.ts 或 main.ts:

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';
await FirebaseCrashlytics.initialize();

平台配置

为 Android 和 iOS 平台设置所需的配置。

Android 配置

  1. 在应用级别的 build.gradle 中添加 Crashlytics Gradle 插件 build.gradle 文件:

    buildscript { 
        dependencies { 
            classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.5' 
        } 
    }
    apply plugin: 'com.google.firebase.crashlytics'
  2. 在 build.gradle 中启用崩溃收集 AndroidManifest.xml:

    <meta-data
        android:name="firebase_crashlytics_collection_enabled"
        android:value="true" />

iOS 配置

  1. 在以下位置配置 Firebase: AppDelegate.swift:

    import Firebase
    FirebaseApp.configure()

测试你的配置

通过触发一次测试崩溃并检查 Firebase Console,确认 Crashlytics 是否正常工作:

  • 使用自定义键触发测试崩溃:

    await FirebaseCrashlytics.setCustomKey({key: 'test_scenario', value: 'manual_crash'});
    await FirebaseCrashlytics.crash();
  • 可选:识别用户:

    await FirebaseCrashlytics.setUserId({userId: 'user123'});
  • 记录自定义事件:

    await FirebaseCrashlytics.log({message: 'Test crash triggered'});

报告(包括堆栈跟踪、设备详情和自定义键)应在约 5 分钟内出现在 Firebase Console 中。

重要提示: 发布应用前请移除崩溃调用。要在开发期间禁用崩溃收集,请使用:

await FirebaseCrashlytics.setCrashlyticsCollectionEnabled({enabled: false});

监控指南

通过测试崩溃确认设置无误后,使用 Firebase Console 跟踪线上应用中的实际崩溃和错误。

查看崩溃报告

你可以在 Firebase Console 的 Crashlytics 板块中找到崩溃报告。以下是具体内容:

  • 无崩溃用户数:未发生崩溃的用户占比。
  • 问题稳定性:崩溃发生的频率。
  • 影响分析:受影响的用户数量。

点击任意问题即可深入查看详情,包括堆栈跟踪、设备信息(如 OS 版本、内存)、custom keys、logs,以及崩溃前的用户操作路径。

专家提示:启用“velocity alerts”功能,在崩溃率突然升高时收到通知。这能帮助你在问题影响过多用户之前及时处理。

错误管理技巧

  • 按影响程度排序:优先处理影响最多用户或发生在 App 关键部分的崩溃。追踪趋势有助于你识别紧急问题。

  • 使用 Custom Keys:通过 custom keys 为崩溃报告添加上下文信息。例如:

    await FirebaseCrashlytics.setCustomKey({
      key: 'current_view',
      value: 'payment_processing'
    });
  • 分组相似问题:利用 Firebase 的自动问题分组功能。你还可以使用一致的自定义键标记相关崩溃,并采用清晰、描述性的标题以便更轻松地追踪。

保护用户隐私

为确保合规并保护用户数据,请遵循以下准则:

  • 权限:

    • 在隐私政策中提及崩溃报告。
    • 在受 GDPR 法规约束的地区,获取用户同意以收集数据。
    • 为用户提供退出崩溃报告的选项。
  • 数据收集控制:

    await FirebaseCrashlytics.setCrashlyticsCollectionEnabled({enabled: false});
    await FirebaseCrashlytics.setCrashlyticsCollectionEnabled({enabled: true});
  • 数据保留:

    • 设置 90 天后自动删除数据。
    • 从报告中清除敏感信息。
    • 在调试时使用不可识别的自定义键,以保护用户隐私。

Capgo 集成

Capgo Live Update Dashboard 界面

将 Capgo 的 live update 系统与 Crashlytics 结合,简化从崩溃检测到修复部署的全流程。

关于 Capgo

Capgo 是一款专为以下场景设计的 live update 工具: Capacitor 应用。目前已有超过 1,900 款应用投入生产,24 小时内的更新率达 95%,确保无需等待应用商店审核即可快速修复问题。 [1].

核心功能包括:

  • 端到端加密 实现安全更新
  • 一键回滚 回退至旧版本
  • 基于 Channel 的分发 用于定向发布
  • 无缝集成 CI/CD
  • 一套 100% 开源平台

Crashlytics 与 Capgo 搭配使用

将 Crashlytics 与 Capgo 结合使用,可以构建高效的工作流,快速定位并解决问题。

工作原理如下:

  1. 崩溃检测与响应
    Crashlytics 识别崩溃后,Capgo 可让你无需等待应用商店审核,立即部署修复。

  2. 定向更新

    • Beta 测试: 通过特定用户群测试修复效果,确保方案有效。
    • 分阶段发布: 逐步部署更新,降低风险。
    • 紧急修复: 快速推送关键补丁,解决紧急问题。
  3. 监控与验证
    使用 Capgo 部署更新后,利用 Crashlytics 追踪崩溃率,确认问题已解决。

安全与 App Store 规则

Capgo 在提供强大安全特性的同时,严格遵守 Apple 和 Google 的政策:

  • 更新交付的全球成功率达 82% [1]
  • 自动版本控制,让管理更有序
  • 符合 App Store live update 指南

如需安全集成 Crashlytics:

  • 在两个系统中都启用错误追踪。
  • 结合 Crashlytics 报告,使用 Capgo 的监控工具。
  • 对所有更新保持版本控制。
  • 保留详细的更新日志以供审计。

前往 Plugin Options 部分,探索其他 live update 工具。

插件选项

选择合适的崩溃报告插件,会极大影响你定位和修复 App 错误的效果。

以下是 Crashlytics 与其他主流 Capacitor 错误报告工具的快速对比:

  • Sentry: 提供免费套餐,付费方案每月 $26 起。支持 30 多个平台,并提供实时错误监控,包含详细上下文。
  • Bugsnag: 每月 $47 起。覆盖移动端和 Web 平台,具备自动错误分组和发布追踪功能。
  • Rollbar: 每月 $31 起。支持多平台,具备部署追踪和用户追踪等功能。

由于集成顺畅且提供免费套餐,Crashlytics 对已在使用 Firebase 的团队非常有吸引力。

总结

以下是您已完成的工作和接下来的步骤:

配置步骤回顾

您已完成开始使用所需的三个关键步骤:

  • 创建了 Firebase 项目并注册了 iOS/Android 应用。
  • 安装并配置了 Crashlytics 插件。
  • 已更新所需的 iOS 和 Android 平台文件。

为什么要集成这些工具?

将 Firebase Crashlytics 与 Capgo 搭配使用,可为你打造强大的错误追踪系统,并实现更多功能。 更新管理以下是这一组合带来的优势:

  • 快速修复:一键推送即时更新并回滚更改。
  • 可靠发布:确保更新被广泛采用并顺利交付给用户。

接下来做什么?

  1. 在 Firebase Console 中启用详细的崩溃分析。
  2. 将 Capgo 添加到你的 CI/CD pipeline,让更新流程更顺畅。
  3. 使用 Capgo 通道 逐步测试并发布修复。

有了 Crashlytics 和 Capgo,你就能让应用持续稳定运行并不断改进。

在 Firebase Crashlytics 基础上继续:Capacitor 应用

如果你正在使用 面向 Capacitor 应用的 Firebase Crashlytics 要规划原生插件工作,请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 查看添加或更新插件中的实现细节, Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流,以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。

为 Capacitor 应用提供 Live Updates

当 Web 层出现线上 Bug 时,通过 Capgo 发布修复,而不用等 App Store 审核好几天。用户会在后台收到更新,原生变更则仍走正常审核流程。

博客最新动态

Capgo 为你提供打造真正专业的移动应用所需的最有价值的洞察。