故障日志获取

2024-01-23 17:16 更新
说明

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

导入模块

  1. import faultLogger from '@ohos.faultLogger'

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.query9+

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

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

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

参数:

参数名

类型

必填

说明

faultType

FaultType

输入要查询的故障类型。

callback

AsyncCallback<Array<FaultLogInfo>>

回调函数,在回调函数中获取故障信息数组。

- value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串

错误码:

以下错误码的详细介绍参见ohos.faultLogger错误码

错误码ID

错误信息

10600001

The service is not started or is faulty

示例:

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

faultLogger.query9+

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

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

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

参数:

参数名

类型

必填

说明

faultType

FaultType

输入要查询的故障类型。

返回值:

类型

说明

Promise<Array<FaultLogInfo>>

Promise实例,可以在其then()方法中获取故障信息实例,也可以使用await。

- value拿到故障信息数组;value为undefined表示获取过程中出现异常

错误码:

以下错误码的详细介绍参见ohos.faultLogger错误码

错误码ID

错误信息

10600001

The service is not started or is faulty

示例:

  1. async function getLog() {
  2. try {
  3. let value = await faultLogger.query(faultLogger.FaultType.JS_CRASH);
  4. if (value) {
  5. console.info("value length is " + value.length);
  6. let len = value.length;
  7. for (let i = 0; i < len; i++) {
  8. console.info("log: " + i);
  9. console.info("Log pid: " + value[i].pid);
  10. console.info("Log uid: " + value[i].uid);
  11. console.info("Log type: " + value[i].type);
  12. console.info("Log timestamp: " + value[i].timestamp);
  13. console.info("Log reason: " + value[i].reason);
  14. console.info("Log module: " + value[i].module);
  15. console.info("Log summary: " + value[i].summary);
  16. console.info("Log text: " + value[i].fullLog);
  17. }
  18. }
  19. } catch (err) {
  20. console.error(`code: ${err.code}, message: ${err.message}`);
  21. }
  22. }

faultLogger.querySelfFaultLog(deprecated)

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

说明

从API version 9开始废弃,建议使用faultLogger.query替代。

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

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

参数:

参数名

类型

必填

说明

faultType

FaultType

输入要查询的故障类型。

callback

AsyncCallback<Array<FaultLogInfo>>

回调函数,在回调函数中获取故障信息数组。

- value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串

示例:

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

faultLogger.querySelfFaultLog(deprecated)

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

说明

从API version 9开始废弃,建议使用faultLogger.query替代。

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

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

参数:

参数名

类型

必填

说明

faultType

FaultType

输入要查询的故障类型。

返回值:

类型

说明

Promise<Array<FaultLogInfo>>

Promise实例,可以在其then()方法中获取故障信息实例,也可以使用await。

- value拿到故障信息数组;value为undefined表示获取过程中出现异常

示例:

  1. async function getLog() {
  2. let value = await faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH);
  3. if (value) {
  4. console.info("value length is " + value.length);
  5. let len = value.length;
  6. for (let i = 0; i < len; i++) {
  7. console.info("log: " + i);
  8. console.info("Log pid: " + value[i].pid);
  9. console.info("Log uid: " + value[i].uid);
  10. console.info("Log type: " + value[i].type);
  11. console.info("Log timestamp: " + value[i].timestamp);
  12. console.info("Log reason: " + value[i].reason);
  13. console.info("Log module: " + value[i].module);
  14. console.info("Log summary: " + value[i].summary);
  15. console.info("Log text: " + value[i].fullLog);
  16. }
  17. }
  18. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号