harmony 鸿蒙@ohos.faultLogger (FaultLogger)

  • 2025-06-12
  • 浏览 (3)

@ohos.faultLogger (FaultLogger)

The faultLogger APIs can be used to query fault logs of an application cached on the system. The APIs use the application bundle name and the UID allocated by the system as the unique key value. The number of application fault logs stored in the system is limited by the system log pressure. You are advised to use @ohos.hiviewdfx.hiAppEvent to subscribe to fault events such as APP_CRASH and APP_FREEZE.

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs of this module are no longer maintained since API version 18. You are advised to use @ohos.hiviewdfx.hiAppEvent to subscribe to the APP_CRASH and APP_FREEZE events in later versions.

Modules to Import

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

FaultType

Enumerates the fault types.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Name Value Description
NO_SPECIFIC 0 No specific fault type.
CPP_CRASH 2 C++ program crash.
JS_CRASH 3 JS program crash.
APP_FREEZE 4 Application freezing.

FaultLogInfo

Defines the data structure of the fault log information.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Name Type Mandatory Description
pid number Yes Process ID of the faulty process.
uid number Yes User ID of the faulty process.
type FaultType Yes Fault type.
timestamp number Yes Millisecond-level timestamp when the log was generated.
reason string Yes Reason for the fault.
module string Yes Module on which the fault occurred.
summary string Yes Summary of the fault.
fullLog string Yes Full log text.

FaultLogger.query9+

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

Obtains the fault information about the current application. This API uses an asynchronous callback to return the fault information array obtained, which contains a maximum of 10 pieces of fault information.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Parameters

Name Type Mandatory Description
faultType FaultType Yes Fault type.
callback AsyncCallback<Array<FaultLogInfo>> Yes Callback used to return the fault information array.
value is the fault information array obtained. If value is undefined, an exception occurs during the information retrieval. In this case, an error string will be returned.

Error codes

For details about the error codes, see FaultLogger Error Codes.

ID Error Message
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.

Example

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;

Obtains the fault information about the current application. This API uses a promise to return the fault information array obtained, which contains a maximum of 10 pieces of fault information.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Parameters

Name Type Mandatory Description
faultType FaultType Yes Fault type.

Return value

Type Description
Promise&lt;Array&lt;FaultLogInfo&gt;&gt; Promise used to return the fault information array. You can obtain the fault information instance in its then() method or use await.
value is the fault information array obtained. If value is undefined, an exception occurs during the information retrieval.

Error codes

For details about the error codes, see FaultLogger Error Codes.

ID Error Message
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.

Example

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

NOTE

This API is deprecated since API version 9. You are advised to use FaultLogger.query.

Obtains the fault information about the current application. This API uses an asynchronous callback to return the fault information array obtained, which contains a maximum of 10 pieces of fault information.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Parameters

Name Type Mandatory Description
faultType FaultType Yes Fault type.
callback AsyncCallback&lt;Array&lt;FaultLogInfo&gt;&gt; Yes Callback used to return the fault information array.
value is the fault information array obtained. If value is undefined, an exception occurs during the information retrieval. In this case, an error string will be returned.

Example

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;

NOTE

This API is deprecated since API version 9. You are advised to use FaultLogger.query.

Obtains the fault information about the current application. This API uses a promise to return the fault information array obtained, which contains a maximum of 10 pieces of fault information.

System capability: SystemCapability.HiviewDFX.Hiview.FaultLogger

Parameters

Name Type Mandatory Description
faultType FaultType Yes Fault type.

Return value

Type Description
Promise&lt;Array&lt;FaultLogInfo&gt;&gt; Promise used to return the fault information array. You can obtain the fault information instance in its then() method or use await.
value is the fault information array obtained. If value is undefined, an exception occurs during the information retrieval.

Example

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 鸿蒙Performance Analysis Kit

harmony 鸿蒙HiAppEvent

harmony 鸿蒙HiAppEvent_AppEventGroup

harmony 鸿蒙HiAppEvent_AppEventInfo

harmony 鸿蒙HiCollie

harmony 鸿蒙HiCollie_DetectionParam

harmony 鸿蒙HiCollie_SetTimerParam

harmony 鸿蒙HiDebug

harmony 鸿蒙HiDebug_MemoryLimit

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