故障日志获取


故障日志获取

icon-note.gif 说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import faultLogger from '@ohos.faultLogger'
1

FaultType

故障类型枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。

名称 默认值 说明
NO_SPECIFIC 0 不区分故障类型
CPP_CRASH 2 C++程序故障类型
JS_CRASH 3 JS程序故障类型
APP_FREEZE 4 应用程序卡死故障类型

FaultLogInfo

故障信息数据结构,获取到的故障信息的数据结构。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。

名称 参数类型 说明
pid number 故障进程的进程id
uid number 故障进程的用户id
type FaultType 故障类型
timestamp number 日志生成时的秒级时间戳
reason string 发生故障的原因
module string 发生故障的模块
summary string 故障的概要
fullLog string 故障日志全文

faultLogger.querySelfFaultLog

querySelfFaultLog(faultType: FaultType, callback: AsyncCallback<Array<FaultLogInfo>>) : void

获取当前进程故障信息,该方法通过回调方式获取故障信息数组,故障信息数组内最多上报10份故障信息。

系统能力: SystemCapability.HiviewDFX.Hiview.FaultLogger

参数:

参数名 类型 必填 说明
faultType FaultType 输入要查询的故障类型。
callback AsyncCallbackArray<Array<FaultLogInfo>> 回调函数,在回调函数中获取故障信息数组。
- value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串

示例:

function queryFaultLogCallback(error, value) {
    if (error) {
        console.info('error is ' + error);
    } else {
        console.info("value length is " + value.length);
        let len = value.length;
        for (let i = 0; i < len; i++) {
            console.info("log: " + i);
            console.info("Log pid: " + value[i].pid);
            console.info("Log uid: " + value[i].uid);
            console.info("Log type: " + value[i].type);
            console.info("Log ts: " + value[i].ts);
            console.info("Log reason: " + value[i].reason);
            console.info("Log module: " + value[i].module);
            console.info("Log summary: " + value[i].summary);
            console.info("Log text: " + value[i].fullLog);
        }
    }
}
faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH, queryFaultLogCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

faultLogger.querySelfFaultLog

querySelfFaultLog(faultType: FaultType) : Promise<Array<FaultLogInfo>>

获取当前进程故障信息,该方法通过Promise方式返回故障信息数组,故障信息数组内最多上报10份故障信息。

系统能力: SystemCapability.HiviewDFX.Hiview.FaultLogger

参数:

参数名 类型 必填 说明
faultType FaultType 输入要查询的故障类型。

返回值:

类型 说明
Promise<Array<FaultLogInfo>> Promise实例,可以在其then()方法中获取故障信息实例,也可以使用await。
- value拿到故障信息数组;value为undefined表示获取过程中出现异常

示例:

async function getLog() {
    let value = await faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH);
    if (value) {
        console.info("value length is " + value.length);
	let len = value.length;
	for (let i = 0; i < len; i++) {
	    console.info("log: " + i);
	    console.info("Log pid: " + value[i].pid);
	    console.info("Log uid: " + value[i].uid);
	    console.info("Log type: " + value[i].type);
	    console.info("Log ts: " + value[i].ts);
	    console.info("Log reason: " + value[i].reason);
	    console.info("Log module: " + value[i].module);
	    console.info("Log summary: " + value[i].summary);
	    console.info("Log text: " + value[i].fullLog);
	}
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18