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

  • 2025-06-16
  • 浏览 (2)

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

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.info('error is ' + error);
    } 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.query9+

query(faultType: FaultType) : Promise&lt;Array&lt;FaultLogInfo&gt;&gt;

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

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

参数：

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

返回值：

类型 说明
Promise&lt;Array&lt;FaultLogInfo&gt;&gt; Promise实例，可以在其then()方法中获取故障信息实例，也可以使用await。
-&nbsp;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 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);
      }
    }
  } catch (err) {
    console.error(`code: ${(err as BusinessError).code}, message: ${(err as BusinessError).message}`);
  }
}

FaultLogger.querySelfFaultLog(deprecated)

querySelfFaultLog(faultType: FaultType, callback: AsyncCallback&lt;Array&lt;FaultLogInfo&gt;&gt;) : void

说明：

从 API Version 9 开始废弃，建议使用FaultLogger.query替代。

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

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

参数：

参数名 类型 必填 说明
faultType FaultType 是 输入要查询的故障类型。
callback AsyncCallback&lt;Array&lt;FaultLogInfo&gt;&gt; 是 回调函数，在回调函数中获取故障信息数组。
-&nbsp;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.info('error is ' + error);
  } 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);
    }
  }
}
FaultLogger.querySelfFaultLog(FaultLogger.FaultType.JS_CRASH, queryFaultLogCallback);

FaultLogger.querySelfFaultLog(deprecated)

querySelfFaultLog(faultType: FaultType) : Promise&lt;Array&lt;FaultLogInfo&gt;&gt;

说明：

从 API Version 9 开始废弃，建议使用FaultLogger.query替代。

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

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

参数：

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

返回值：

类型 说明
Promise&lt;Array&lt;FaultLogInfo&gt;&gt; Promise实例，可以在其then()方法中获取故障信息实例，也可以使用await。
-&nbsp;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 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);
    }
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Performance Analysis Kit（性能分析服务）

harmony 鸿蒙HiAppEvent

harmony 鸿蒙HiAppEvent_AppEventGroup

harmony 鸿蒙HiAppEvent_AppEventInfo

harmony 鸿蒙HiCollie

harmony 鸿蒙HiCollie_DetectionParam

harmony 鸿蒙HiCollie_SetTimerParam

harmony 鸿蒙HiDebug

harmony 鸿蒙HiDebug_JsStackFrame

harmony 鸿蒙HiDebug_MemoryLimit

0  赞
  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/BaLQ7V
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录