Cchenshi51fix:update faultlogger example code

f575fac0创建于 2025年8月29日历史提交

@ohos.faultLogger (故障日志获取)

应用可以使用faultLogger接口查询系统侧缓存的当前应用的故障日志。接口以应用包名和系统分配的UID作为唯一键值。系统侧保存的应用故障日志数量受系统日志的压力限制，推荐使用@ohos.hiviewdfx.hiAppEvent订阅APP_CRASH及APP_FREEZE等故障事件。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口从API version 18开始废弃使用, 该接口不再维护。后续版本推荐使用@ohos.hiviewdfx.hiAppEvent订阅APP_CRASH，APP_FREEZE事件。

导入模块

import { FaultLogger } from '@kit.PerformanceAnalysisKit';

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.query⁹⁺

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

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

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

参数：

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

错误码：

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

错误码ID	错误信息
401	The parameter check failed, Parameter type error.
801	The specified SystemCapability name was not found.
10600001	The service is not started or is faulty.

示例：

import { FaultLogger } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

function queryFaultLogCallback(error: BusinessError, value: Array<FaultLogger.FaultLogInfo>) {
    if (error) {
        console.error(`error code:${error.code}, error msg:${error.message}`);
    } else {
        console.info("value length is " + value.length);
        let len: number = 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 timestamp: ${value[i].timestamp}`);
            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}`);
        }
    }
}
try {
    FaultLogger.query(FaultLogger.FaultType.JS_CRASH, queryFaultLogCallback);
} catch (err) {
    console.error(`code: ${(err as BusinessError).code}, message: ${(err as BusinessError).message}`);
}

FaultLogger.query⁹⁺

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

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

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

参数：

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

返回值：

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

错误码：

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

错误码ID	错误信息
401	The parameter check failed, Parameter type error.
801	The specified SystemCapability name was not found.
10600001	The service is not started or is faulty.

示例：

import { FaultLogger } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

async function getLog() {
  try {
    let value: Array<FaultLogger.FaultLogInfo> = await FaultLogger.query(FaultLogger.FaultType.JS_CRASH);
    if (value) {
      console.info(`value length: ${value.length}`);
      let len: number = 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 timestamp: ${value[i].timestamp}`);
        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}`);
      }
    }
  } catch (err) {
    console.error(`code: ${(err as BusinessError).code}, message: ${(err as BusinessError).message}`);
  }
}

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返回错误提示字符串。

示例：

import { FaultLogger } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

function queryFaultLogCallback(error: BusinessError, value: Array<FaultLogger.FaultLogInfo>) {
  if (error) {
    console.error(`error code:${error.code}, error msg:${error.message}`);
  } else {
    console.info(`value length: ${value.length}`);
    let len: number = 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 timestamp: ${value[i].timestamp}`);
      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);

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表示获取过程中出现异常。

示例：

import { FaultLogger } from '@kit.PerformanceAnalysisKit';

async function getLog() {
  let value: Array<FaultLogger.FaultLogInfo> = await FaultLogger.querySelfFaultLog(FaultLogger.FaultType.JS_CRASH);
  if (value) {
    console.info(`value length: ${value.length}`);
    let len: number = 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 timestamp: ${value[i].timestamp}`);
      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}`);
    }
  }
}

@ohos.faultLogger (故障日志获取)

导入模块

FaultType

FaultLogInfo

FaultLogger.query9+

FaultLogger.query9+

FaultLogger.querySelfFaultLog(deprecated)

FaultLogger.querySelfFaultLog(deprecated)

FaultLogger.query⁹⁺

FaultLogger.query⁹⁺

FaultLogger.querySelfFaultLog^(deprecated)

FaultLogger.querySelfFaultLog^(deprecated)