@ohos.hiviewdfx.hiRetrieval (应用灰度)
本模块提供应用灰度故障维测能力，支持以下故障类型：RSS内存泄漏、ArkTS-OOM、FD内存泄漏、GPU内存泄漏。应用灰度特性是一种运维态功能，用于精准采集故障日志。开发者在端侧集成应用灰度功能后，可参与应用灰度活动。通过云端平台发布应用灰度任务，可圈选部分设备开启故障日志精准采集，帮助开发者快速定位故障。
起始版本： 26.0.0
导入模块
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
HiRetrievalConfig
应用灰度活动配置。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| userType | string | 否 | 是 | 用户类型参数值由开发者自定义，无格式和字符类型限制，最长支持128个字符。 |
| deviceType | string | 否 | 是 | 设备类型参数值由开发者自定义，无格式和字符类型限制，最长支持128个字符。 |
| deviceModel | string | 否 | 是 | 设备型号参数值由开发者自定义，无格式和字符类型限制，最长支持128个字符。 |
hiRetrieval.init
init(): void
初始化应用灰度模块。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
hiRetrieval.init();
// 后续可以完成其他的灰度接口调用
hiRetrieval.participate
participate(config: HiRetrievalConfig): void
设置此设备参与应用灰度活动。调用后向服务器发送参与灰度消息和应用灰度活动配置，服务器标记此设备为可圈选并记录该应用灰度活动配置作为算法参数。多次调用将更新为最新的应用灰度活动配置。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| config | HiRetrievalConfig | 是 | 开发者指定的应用灰度活动配置。 |
错误码：
以下错误码的详细介绍请参见应用灰度错误码。
| 错误码ID | 错误信息 |
|---|---|
| 36000001 | Initialization error. Possibly caused by invoking this function before invoking init function |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
hiRetrieval.init();
let config: hiRetrieval.HiRetrievalConfig = {
'userType': "testUserType",
'deviceType': "deviceType",
'deviceModel': "deviceModel"
}
try {
hiRetrieval.participate(config);
} catch (err) {
console.error(`error code: ${(err as BusinessError).code}, error msg: ${(err as BusinessError).message}`);
}
hiRetrieval.quit
quit(): void
设置此设备退出应用灰度活动，退出后此设备将无法在云侧被圈选。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
错误码：
以下错误码的详细介绍请参见应用灰度错误码。
| 错误码ID | 错误信息 |
|---|---|
| 36000001 | Initialization error. Possibly caused by invoking this function before invoking init function |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
hiRetrieval.init();
try {
hiRetrieval.quit();
} catch (err) {
console.error(`error code: ${(err as BusinessError).code}, error msg: ${(err as BusinessError).message}`);
}
hiRetrieval.isParticipant
isParticipant(): boolean
查询此设备是否正在参与应用灰度活动。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 标识此设备现在是否正在参与灰度活动，true表示正在参与，false表示未参与。 |
示例：
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
let isParticipant = hiRetrieval.isParticipant();
hiRetrieval.getLastParticipationTimestamp
getLastParticipationTimestamp(): number
查询此设备上次参与应用灰度活动的UNIX时间戳，如果此设备从未参与则返回0。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
返回值：
| 类型 | 说明 |
|---|---|
| number | 上一次参与应用灰度活动的UNIX时间戳，单位为毫秒。 |
示例：
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
let ts = hiRetrieval.getLastParticipationTimestamp();
hiRetrieval.run
run(): void
若此设备正在参与应用灰度活动，则应用灰度模块开始工作，否则调用该接口不会产生任何效果。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
错误码：
以下错误码的详细介绍请参见应用灰度错误码。
| 错误码ID | 错误信息 |
|---|---|
| 36000001 | Initialization error. Possibly caused by invoking this function before invoking init function |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
hiRetrieval.init();
try {
hiRetrieval.run();
} catch (err) {
console.error(`error code: ${(err as BusinessError).code}, error msg: ${(err as BusinessError).message}`);
}
hiRetrieval.getCurrentConfig
getCurrentConfig(): HiRetrievalConfig
获取当前应用灰度活动配置。
起始版本： 26.0.0
原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.HiviewDFX.HiRetrieval
返回值：
| 类型 | 说明 |
|---|---|
| HiRetrievalConfig | 当前应用灰度活动配置。 |
示例：
import { hiRetrieval } from '@kit.PerformanceAnalysisKit';
let cfg = hiRetrieval.getCurrentConfig();
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 js-apis-hiviewdfx-FaultLogExtensionAbility
openharmony 鸿蒙 errorcode-hisysevent-sys
openharmony 鸿蒙 capi-hitrace-hitraceid
openharmony 鸿蒙 capi-hidebug-hidebug-threadcpuusage
openharmony 鸿蒙 js-apis-loglibrary-sys
openharmony 鸿蒙 capi-hiappevent-h