80987227创建于 2025年6月17日历史提交

使用HiDebug获取调试信息（ArkTS）

为应用提供多种调试和调优方法。包括但不限于内存、CPU、GPU、GC等相关数据的获取，进程trace、profiler采集，VM堆快照转储等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试，调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。

接口说明

接口名	描述
hidebug.getNativeHeapSize	获取内存分配器统计的进程持有的堆内存大小（含分配器元数据）。
hidebug.getNativeHeapAllocatedSize	获取内存分配器统计的进程业务分配的堆内存大小。
hidebug.getNativeHeapFreeSize	获取内存分配器持有的缓存内存大小。
hidebug.getPss	获取应用进程实际使用的物理内存大小。
hidebug.getVss	获取应用进程虚拟耗用内存大小。
hidebug.getSharedDirty	获取进程的共享脏内存大小。
hidebug.getPrivateDirty	获取进程的私有脏内存大小。
hidebug.getCpuUsage	获取进程的CPU使用率。
hidebug.getServiceDump	获取系统服务信息。
hidebug.dumpJsHeapData	虚拟机堆导出。
hidebug.startJsCpuProfiling	启动虚拟机Profiling方法跟踪。
hidebug.stopJsCpuProfiling	停止虚拟机Profiling方法跟踪。
hidebug.getAppVMMemoryInfo	获取VM内存相关信息。
hidebug.getAppThreadCpuUsage	获取应用线程CPU使用情况。
hidebug.startAppTraceCapture	启动应用trace采集。
hidebug.stopAppTraceCapture	停止应用trace采集。
hidebug.getAppMemoryLimit	获取应用程序进程内存限制。
hidebug.getSystemCpuUsage	获取系统的CPU资源占用情况。
hidebug.setAppResourceLimit	设置应用的fd数量、线程数量、js内存或者native内存资源限制。
hidebug.getAppNativeMemInfo	获取应用进程内存信息。
hidebug.getSystemMemInfo	获取系统内存信息。
hidebug.getVMRuntimeStats	获取系统gc全部统计信息。
hidebug.getVMRuntimeStat	根据参数获取指定的系统gc统计信息。
hidebug.isDebugState	获取应用进程被调试状态。
hidebug.getGraphicsMemory	使用异步方式获取应用显存大小。
hidebug.getGraphicsMemorySync	使用同步方式获取应用显存大小。
hidebug.dumpJsRawHeapData	为当前线程转储虚拟机的原始堆快照。

HiDebug的具体用法可查看API参考API参考文档。

开发示例

下文展示如何在应用内添加按钮，并通过点击该按钮调用hidebug接口。

新建一个工程，选择“Empty Ability”。
工程配置界面中，Model选择“Stage”。

在Project窗口单击entry > src > main > ets > pages，打开工程中的Index.ets文件。

添加一个调用hidebug接口的方法，本文以hidebug.getSystemCpuUsage()为例，其他接口可参考API参考文档。

import { hidebug } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
function testHiDebug(event?: ClickEvent) {
  try {
    console.info(`getSystemCpuUsage: ${hidebug.getSystemCpuUsage()}`);
  } catch (error) {
    console.error(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
  }
}

给文本Text组件添加一个点击事件，示例代码如下：

@Entry
@Component
struct Index {
  @State message: string = 'Hello World';

  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(testHiDebug);//添加点击事件
      }
      .width('100%')
    }
    .height('100%')
  }
}

在真机上运行工程，点击应用/服务界面中的“Hello World”文本。
在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件为“testTag”。

此时窗口将显示通过hidebug.getSystemCpuUsage()接口获取的CPU使用率的相关日志。
```
 08-20 11:06:01.891   1948-1948     A03d00/JSAPP                    com.examp...lication  I     getSystemCpuUsage: 0.4722222222222222
```