其他 macOS API

重要

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

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

调整日志级别

可以在控制台中控制从 App Center 显示的日志消息数量。 使用 setLogLevel:-API 在调试时启用其他日志记录。 默认情况下,对于App Store环境,它设置为 LogLevelAssertLogLevelWarning否则设置为 。

若要拥有尽可能多的日志消息,请使用 MSACLogLevelVerbose/LogLevel.verbose

[MSACAppCenter setLogLevel:MSACLogLevelVerbose];
AppCenter.logLevel = .verbose

确定安装

安装应用后,App Center SDK 会为每个设备创建 UUID。 更新应用时,此标识符对于设备保持不变,并且仅在重新安装应用时生成新标识符。 以下 API 可用于调试目的。

NSUUID *installId = [MSACAppCenter  installId];
var installId = AppCenter.installId

标识用户

App Center SDK 支持设置用于扩充故障报告 的用户 ID 。 若要使用此功能,请:

  1. 如 App Center SDK 入门指南中所述,通过调用 :start:withServices: 来配置 App Center SDK
  2. userID使用以下代码在 SDK 中设置 :
[MSACAppCenter setUserId:@"your-user-id"];
AppCenter.userId = "your-user-id"

设置用户 ID 后,可以使用 App Center 的搜索功能搜索该 ID 的特定故障报告。 有关详细信息,请参阅 App Center 的 搜索文档

注意

用户 ID 的值限制为 256 个字符。 它将随故障报告一起显示,但不用于聚合或受影响用户的计数。 如果多次设置用户 ID,将仅使用最后一个用户 ID。 需要在每次启动应用程序之前自行设置用户 ID,因为两次启动之间 SDK 不会存储此值。

在运行时禁用所有服务

如果要一次禁用所有 App Center 服务,请使用 API setEnabled 。 禁用后,SDK 不会将任何信息转发到 App Center。

[MSACAppCenter setEnabled:NO];
AppCenter.enabled = false

若要再次启用所有服务,请使用同一 API,但将 作为参数传递 YES/true

[MSACAppCenter setEnabled:YES];
AppCenter.enabled = true

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

注意

只有在启动之后 AppCenter 才能使用此方法。

禁止网络请求

在 App Center SDK 中,默认允许网络请求。 如果要发送用户关注的 App Center SDK 收集的数据,可以禁止自动发送数据。

[MSACAppCenter setNetworkRequestsAllowed:false];
AppCenter.networkRequestsAllowed = false

在这种情况下,App Center SDK 将继续收集数据,但仅当允许网络请求时才会发送数据。

[MSACAppCenter setNetworkRequestsAllowed:true];
AppCenter.networkRequestsAllowed = true

注意

此值在启动之间保留。

可以随时检查是否允许在 App Center SDK 中发送数据。

[MSACAppCenter isNetworkRequestsAllowed];
AppCenter.networkRequestsAllowed

更改运行时中的服务状态

使用以下代码在运行时启用或禁用服务:

[MSACAnalytics setEnabled:NO];
Analytics.enabled = false

注意

只有在启动之后 Analytics 才能使用此方法。

检查是否已启用 App Center

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

[MSACAppCenter isEnabled];
AppCenter.enabled

注意

此方法只能在启动后 AppCenter 使用,它将始终在启动之前返回 false

在运行时检查 App Center SDK 版本

可以获取当前使用的 App Center SDK 版本。

[MSACAppCenter sdkVersion];
AppCenter.sdkVersion

存储大小

使用 App Center SDK 时,日志将本地存储在设备上。 大型日志可能会占用大量空间,因此可以选择限制本地数据库的大小。 它与 pauseresume API 结合使用也很有用。 如果预期长时间暂停,可以使用更大的数据库大小来存储更多事件。

使用 setMaxStorageSize API 设置本地数据库的大小。 API 是异步的, completionHandler 在启动 App Center 服务时调用 。 因此, setMaxStorageSize 必须在调用 AppCenter.start之前调用 。 只能调用 API 一次。

// Use 20 MB for storage.
[MSACAppCenter setMaxStorageSize:(20 * 1024 * 1024) completionHandler:^(BOOL success) {
    if (!success) {
        // The success parameter is false when the size can't be honored.
    }
}];
[MSACAppCenter start:@"{Your App Secret}", withServices:@[[MSACAnalytics class]]];
// Use 20 MB for storage.
AppCenter.setMaxStorageSize(20 * 1024 * 1024, completionHandler: { (success) in
    if !success {
        // The success parameter is false when the size can't be honored.
    }
})
AppCenter.start(withAppSecret: "{Your App Secret}", services:[Analytics.self])

如果未设置最大存储大小,SDK 将使用默认最大大小 10 MB。 允许设置的最小大小为 20 KB。

注意

实际的最大存储大小可能略高于所选的值。 SQLite 将大小向上舍入到页面大小的下一个倍数。 App Center SDK 使用 4 KB 的页面大小。

注意

超过 25 天的日志将被丢弃。

不成功的 API 调用

调用可能返回 false 的原因 completionHandler 有很多。

  • 指定的大小是无效值, (小于 20 KB 或大于 140 TB) 。
  • 当前数据库大小大于指定的最大大小。
  • 已调用 API。 每个进程只能配置一次。
  • API 已在 或 AppCenter.configure之后AppCenter.start调用。

可以使用日志标记在控制台AppCenter中检查警告和错误,以排查配置问题。