App Center Analytics (React Native)

重要

Visual Studio App Center 计划于 2025 年 3 月 31 日停用。 虽然可以继续使用 Visual Studio App Center,直到它完全停用,但你可以考虑迁移到几个建议的替代方法。

详细了解支持时间线和替代方案。

App Center Analytics 可帮助你了解用户行为和客户参与度,以改进应用。 SDK 自动捕获会话计数和设备属性,例如模型、OS 版本等。可以定义自己的自定义事件来度量对你很重要的事情。 App Center 门户中提供了捕获的所有信息,用于分析数据。

如果尚未在应用程序中设置 SDK,请按照 入门部分 进行操作。

会话和设备信息

将 App Center Analytics 添加到应用并启动 SDK 后,它会自动跟踪会话和设备属性,例如 OS 版本、模型等。

自定义事件

使用 最多 20 个属性 跟踪你自己的自定义事件,以了解用户与应用之间的交互。

启动 SDK 后,使用 trackEvent 方法通过属性跟踪事件。 最多可以发送 200 个不同的事件名称。 此外,每个事件名称的最大限制为 256 个字符,每个事件属性名称和事件属性值的最大限制为 125 个字符。

// import App Center Analytics at the top of the file.
import Analytics from 'appcenter-analytics';

Analytics.trackEvent('Video clicked', { Category: 'Music', FileName: 'favorite.avi' });

此函数返回一个承诺,成功案例返回一个空字符串,错误案例返回错误。

事件的属性是可选的;如果只想跟踪事件,请改用:

Analytics.trackEvent('Video clicked');

在运行时启用或禁用 App Center Analytics

可以在运行时启用和禁用 App Center Analytics。 如果禁用它,SDK 不会为应用收集任何其他分析信息。

await Analytics.setEnabled(false);

此函数返回解析为 void 的承诺。

若要再次启用 App Center Analytics,请使用同一 API,但作为参数传递 true

await Analytics.setEnabled(true);

状态在应用程序启动时保留在设备的存储中。

检查是否启用了 App Center Analytics

还可以检查是否启用 App Center Analytics。

const enabled = await Analytics.isEnabled();

此函数返回解析为 boolean的 promise。

等待 JS 启用 App Center Analytics

如果希望为应用用户收集分析信息,但想要先获取用户权限,可以选择在启动时不启用分析,但要等到合适的时间,改为在 JavaScript 中启用它。

  1. 打开项目的 ios/YourAppName/AppDelegate.m 文件,并将 替换为 [AppCenterReactNativeAnalytics registerWithInitiallyEnabled:true];[AppCenterReactNativeAnalytics registerWithInitiallyEnabled:false];
  2. 打开项目的 android/app/src/main/res/values/strings.xml 文件,并将 替换为 <string name="appCenterAnalytics_whenToEnableAnalytics" moduleConfig="true" translatable="false">ALWAYS_SEND</string><string name="appCenterAnalytics_whenToEnableAnalytics" moduleConfig="true" translatable="false">ENABLE_IN_JS</string>

这意味着,若要将任何信息发送到 App Center (甚至基本会话信息) ,必须先通过添加以下代码行来启用 App Center Analytics:

await Analytics.setEnabled(true);

管理启动会话

默认情况下,会话 ID 取决于应用程序的生命周期。 如果要手动控制新会话的开始,请执行后续步骤:

注意

请注意,每次调用 Analytics.StartSession () API 都会生成一个新会话。 如果在手动会话跟踪器模式下不会调用此 API,则所有发送日志都将具有 null 会话值。

注意

请注意,新应用程序启动后,将重新生成会话 ID。

若要手动配置 SDK 以跟踪会话,必须使用本机 Analytics enableManualSessionTracker API:

  • 在 iOS 中,在 应用的didFinishLaunchingWithOptions委托方法中AppDelegate.m调用 [MSACAnalytics enableManualSessionTracker]; 之前[AppCenterReactNative register];。 如果该文件中缺少,则添加 @import AppCenterAnalytics

  • 在 Android 中,在 中的 方法之前MainApplication.javaonCreate调用 Analytics.enableManualSessionTracker();SoLoader.init 。 如果该文件中缺少,则添加导入 com.microsoft.appcenter.analytics.Analytics

然后,可以在React Native项目中使用该 startSession API:

Analytics.startSession();

本地存储大小

默认情况下,SDK 在存储中存储最多 10 MB 的日志。

无 Internet 访问

如果没有任何网络连接,SDK 将最多 10 MB 的日志保存在本地存储中。 存储已满后,SDK 将开始放弃旧日志,为新日志腾出空间。 设备返回 Internet 访问权限后,SDK 将以 50 次或每隔 6 秒发送一批日志。

批处理事件日志

App Center SDK 会批量上传 50 个日志,如果 SDK 没有要发送的 50 个日志,它仍将在 6 秒后发送日志。 最多可以并行发送三批。

重试和回退逻辑

App Center SDK 支持对可恢复的网络错误进行回退重试。 下面是重试逻辑:

  • 3 尝试每个请求的最大值。
  • 每个请求都有自己的重试状态机。
  • 所有传输通道 (禁用,直到下一个应用进程) 后,一个请求耗尽其所有重试。

回退逻辑

  • 50% 随机化,第一次重试在 5 秒到 10 秒之间,第二次重试在 2.5 到 5 分钟之间,最后一次重试在 10 到 20 分钟之间。
  • 如果网络从关机切换到 (或从 wi-fi 切换到移动) ,则重试状态会重置并立即重试请求。