腾讯云可观测平台 SDK 配置

一、概述

平台支持丰富的配置能力，用户可以在 终端性能监控 Pro > 应用配置 > SDK 配置 通过配置控制 SDK 的行为，如是否允许开启某个监控功能，是否允许上传自定义文件等。

应用创建完成后，配置任务列表为空，用户需要创建配置任务。如需调整已有的配置任务，同时支持进行修改，且所有对配置进行的操作，会显示在配置修改历史中。

用户可以创建多个配置任务，为每个配置任务设置恰当的优先级以及过滤条件。当应用来拉取配置时，配置系统会根据配置请求中的参数，挑选出满足过滤条件的配置任务，在这些配置任务中找到优先级最高的任务返回给应用。

·过滤条件：描述一个配置任务要求来拉取的用户需要满足的特征。

·优先级：描述当一个用户匹配到多个配置任务时，如何选择任务。当前是挑选优先级最高的任务。如果匹配的多个任务，优先级是一样的，则配置系统会随机选择一个任务返回。

二、新建配置任务

1. 进入 终端性能监控 Pro > 应用配置 > SDK 配置 页面，单击新建配置，为对应的产品创建一个新的配置任务。

2. 配置任务，配置项如下：

3. 配置完成后单击提交，即可在配置任务中查看新建的任务。新建的任务默认状态关闭，需要用户主动开启。

四、开启/关闭配置

1. 用户可以直接操作配置状态，开启或者关闭配置任务。

注意：说明：

注意：应用拉取配置时，配置系统只取开启中的配置任务来进行匹配，未开启的配置任务不参与匹配，应用无法拉取到未开启的配置任务。如果用户想临时废弃某个配置任务，可以通过关闭该任务来实现。

2. 单击确定即可开启或者关闭配置任务。

五、修改配置任务

无论是生效中的配置任务（已开启的配置任务），还是未生效的配置任务（未开启的配置任务），都支持修改，单击操作列的编辑即可进行修改。

完成修改配置任务，单击提交，配置便会修改完成。

六、复制配置任务

无论是生效中的配置任务（已开启的配置任务），还是未生效的配置任务（未开启的配置任务），都支持复制，单击操作列的复制即可进行拉起指定任务配置的副本并进入编辑状态。

依据复制目的修改配置任务，单击提交后，便会生成新的配置。

七、删除配置任务

无论是生效中的配置任务（已开启的配置任务），还是未生效的配置任务（未开启的配置任务），都支持删除。生效中的配置任务被删除后，应用下次拉取时，就不会再拉到被删除的配置任务。

单击操作列的删除，然后在弹出的窗口中单击确定即可完成删除。

八、查看修改历史

配置修改历史记录了用户对配置任务执行的任何操作，包含新建配置任务，开启或者关闭配置任务，编辑配置任务以及删除配置任务。

支持查看某个配置任务的修改历史，如下示例，查看白名单配置的修改历史。也支持查看，某个用户的修改历史。

九、过滤条件

在配置任务列表中，将展示当前任务的过滤条件。

十、版本类型

版本类型即应用版本类型，用于描述当前的应用版本，支持开发版、灰度版、正式版，且支持多选，默认不限制。应用没有设置的情况下，应用版本类型的默认值是未知类型。建议初始化 SDK 时，设置正确的应用版本类型。

·Android SDK：通过 BuglyBuilder#appVersionType 初始化参数设置应用版本类型。

·iOS SDK：通过 BuglyConfig#setBuildConfig 接口设置应用版本类型。

示例：设置拉取的版本类型，当应用版本为灰度版和正式版，才能拉取当前配置任务。

十一、APP 版本

APP 版本即应用版本，用于描述当前接入 SDK 的应用的版本号。

·Android SDK：通过 BuglyBuilder#appVersion 初始化参数设置 APP 版本。

·iOS SDK：通过 BuglyConfig#setAppVersion 接口设置应用版本。

示例：当 APP 版本为"4.5.6" 或者 "4.5.7"时， 才能拉取当前配置任务。

十二、SDK 版本

SDK 版本指终端性能监控 Pro SDK 的版本，对应接入时所依赖的 SDK 版本，支持多个，默认不限制。

示例：当 SDK 版本是"4.3.0"或者"4.3.0.1"时，才能拉取当前配置任务。

十三、系统版本

系统版本指当前运行应用的操作系统的版本，SDK 直接读取系统版本属性。系统版本支持设置多个，默认不限制。

·Android SDK：SDK 初始化时自动获取 Build.VERSION.RELEASE 字段，格式如"12","13","9","8.0.0"之类。

·iOS SDK：SDK 初始化时自动获取 [[UIDevice currentDevice] systemVersion]字段，格式如"14.1","16.1"之类。

示例：当系统版本是12、13、9、8.1，或者8.0.0时，才能拉取当前配置任务。

十四、机型

机型即设备类型，一般用来表示一种型号的设备。

·Android SDK：通过 BuglyBuilder#deviceModel 初始化参数设置机型，如果应用没有设置，初始化时会自动读取 Build.MODEL。

示例：当机型为 V2034A、V2065或者 V5048AD 时，才能拉取当前配置任务。

·iOS SDK：SDK 初始化时自动获取 sysctlbyname 字段，格式如"iPhone13,4","iPhone15,3"之类。

示例：当机型为 iPhone11或者 iPhone12时，才能拉取当前配置任务。

十五、用户白名单

用户白名单对应 SDK 中的用户 ID，支持设置多个，默认是不限制。

·Android SDK：通过 BuglyBuilder#userId 初始化参数设置用户 ID，如果应用没有设置，则用户 ID 为空。

·iOS SDK：通过 BuglyInitParam#setUserId 接口设置用户 ID。如果应用没有设置，则用户 ID 为空。

示例：当用户 ID 为"marry"或者"mike"时，才能拉取当前配置任务。

十六、设备白名单

设备白名单对应 SDK 中的设备 ID，支持设置多个，默认是不限制。

·Android SDK：通过 BuglyBuilder#uniqueId 初始化参数设置设备 ID。如果应用没有设置，SDK 会优先从 SP 缓存中读取。如果缓存为空，则随机生成一个并且更新到缓存中。一旦用户设置设备 ID，SDK 会用应用设置的设备 ID 覆盖 SP 缓存。

·iOS SDK：通过 BuglyInitParam#setDeviceId 接口设置设备 ID。如果应用没有设置，则设备 ID 为空。该字段用来统计设备崩溃率、设备 FOOM 率等设备异常率，请务必设置。

示例：当设备 ID 为"b171a7113a0cfb05"或者"2ee44f2a31f030a"时，才能拉取当前配置任务。

多条件组合示例：版本类型是开发版，APP 版本是"4.6.7"，且是 Android 12的系统，则该配置任务满足条件。

十七、配置内容

Android 和 iOS 平台所支持的具体配置项有些差异，有关配置项的详细说明，请参考两端 SDK 的接入指引。除具体的配置项差异外，其他逻辑两端表现一致。

十八、设备采样率

绝大部分配置项有一个采样率（"sample_ratio"）参数，表示该监控能力的设备采样率。当前是后台采样，配置系统会根据拉取配置的设备情况，去通知 SDK。当前设备是允许开启某个监控项，或者禁用某个监控项。取值范围为[0,1]：

·1：表示所有设备都允许开启某个监控项。

·0：表示所有设备都不允许开启某个监控项。

·取[0,1]之间的某个值 a：表示按 a 指定的概率，部分设备允许开启某个监控项，部分设备不允许开启某个监控项。例如 a=0.3，表示30%的设备允许开启指定监控项，70%的设备不允许开启指定监控项。

示例：允许所有的设备开启内存峰值监控，只允许10%的设备开启大图分析功能。

十九、Android 配置项

·崩溃、ANR、OOM 是100%上报，不支持采样，默认开启。除崩溃、ANR、OOM 外，其他监控项支持采样。一般情况下，性能指标监控默认开启，性能异常监控默认关闭，用户可以通过 SDK 配置调整开启情况。在接入时，请务必确认功能的开启情况符合你的预期。

·需要在 终端性能监控 Pro > 应用配置 > SDK 配置 中，修改配置开关，指定监控项的采样率。

·在接入期间，建议全采样，即将所有采样率调整为1.0，方便验证数据上报。接入完成后，再根据需要，调整采样率。或者创建多个配置任务，根据版本类型（对应初始化的 builder.appVersionType），配置开发任务、灰度任务，和正式任务。开发任务打开所有的监控项，灰度阶段按需采样，正式发布根据需要降低采样。

各监控项的配置参数说明如下：

20、质量监控

21、启动监控

22、卡顿监控

23、内存监控

注意：Java 内存泄露监控配置说明：

注意："activity_leak"的"sample_ratio"和"event_sample_ratio"的差异如下：

24、进程退出分析

25、流量监控

26、电量监控

27、网络监控

28、ASan 内存错误检测

29、页面打开耗时

30、iOS 配置项

·崩溃是100%上报，不支持采样。

·需要在 终端性能监控 Pro > 应用配置 > SDK 配置 中，修改配置开关，指定监控项的采样率。

·在接入期间，建议全采样，即将所有采样率调整为1.0，方便验证数据上报。接入完成后，再根据需要调整采样率。或者创建多个配置任务，根据版本类型（对应初始化的 BuglyConfig.buildConfig），配置开发任务、灰度任务，以及正式任务。开发任务打开所有的监控项，灰度阶段按需采样，正式发布根据需要降低采样。

31、卡顿指标监控

32、卡顿问题监控

33、卡顿问题-工作线程监控

threads 中每个子配置的字段含义：

34、ANR 监控

35、启动抓栈

慢启动抓栈，配置开启时，当启动耗时超过 launch_backtrace_threshold_ms 会开启抓栈，耗时超过 launch_deadlock_threshold_ms 时认为启动异常，上报数据到卡顿模块。可以通过自定义字段 "BuglyAppState" 为 "coldLaunch" 进行筛选。

36、内存指标监控

37、FOOM 监控

malloc_size_record_thresholds 中每个子配置的字段含义

38、VC 内存泄漏监控

39、大内存分配监控

40、内存详情监控

注意：说明：

41、崩溃监控

Bugly crash 功能开关，无特殊字段，不配置时默认开启。支持2.7.49及以上版本。

42、错误监控

自定义错误上报开关，不配置时默认开启。支持2.7.49及以上版本。

43、Crash zombie 检测

zombie 检测能力开关，支持2.7.1及以上版本。

44、Crash 自定义附件上传控制

crash 自定义文件上传，默认关闭。支持2.7.39及以上版本。

45、Crash minidump 采集控制

crash minidump 附件信息，开启后会在 crash 时采集 minidump 信息并在二次启动上报，默认关闭。支持2.7.55及以上版本。

46、Crash 公共附件上传控制

crash common_file 公共附件上传能力，客户端可以为每个事件上传不同文件名的附件，默认打开。支持2.7.55及以上版本。

47、启动指标采集控制

启动指标相关配置，控制后台进前台指标是否上报，默认关闭，冷启动不受控制。

48、冷启动指标采集控制

冷启动指标相关配置，无配置默认开启。

49、后台进前台指标采集控制

后台进前台指标相关配置，无配置默认开启。

50、metric kit 采集控制

51、DAU 采集控制

DAU 上报开关，默认开启。支持2.7.49及以上版本。

推荐配置：

{ "name": "common.dau", "sample_ratio": 1, "daily_report_limit": 10000}

52、操作路径采集控制

vc 操作路径上报开关，SDK 2.7.3（不包含）之后添加。

53、10分钟流量采集控制

流量异常监控，开启后，App 流量监控将变为更细粒度，每10min 汇总上报一次，超过对应阈值，将上报对应网络请求详情。

54、页面性能采集控制

页面打开耗时，开启后会上报 App 各个 UIViewController 打开的耗时，默认关闭。支持2.8.0-beta 及以上版本。

55、Harmony 配置项

·崩溃是100%上报，不支持采样。除崩溃外，其他监控能力都支持采样，默认是全部关闭。

·需要在 终端性能监控 Pro > 应用配置 > SDK 配置 中，修改配置开关，指定监控项的采样率。

·在接入期间，建议全采样，即将所有采样率调整为1.0，方便验证数据上报。接入完成后，再根据需要调整采样率。或者创建多个配置任务，根据版本类型（对应初始化的 BuglyConfig.buildconfig），配置开发任务、灰度任务，以及正式任务。开发任务打开所有的监控项，灰度阶段按需采样，正式发布根据需要降低采样。

各监控项的配置参数说明如下。

56、质量监控

57、卡顿监控