1# 使用HiDebug获取调试信息（ArkTS）
2
3HiDebug对外提供系统调试相关功能的接口，包括应用进程的静态堆内存（native heap）信息、应用进程内存占用PSS（Proportional Set Size）信息的获取等，也可完成虚拟机内存切片导出，虚拟机CPU Profiling采集等操作。
4
5## 接口说明
6
7| 接口名                             | 描述                                                         |
8| ---------------------------------- | ------------------------------------------------------------ |
9| hidebug.getNativeHeapSize          | 获取内存分配器统计的进程持有的堆内存大小（含分配器元数据）。 |
10| hidebug.getNativeHeapAllocatedSize | 获取内存分配器统计的进程业务分配的堆内存大小。               |
11| hidebug.getNativeHeapFreeSize      | 获取内存分配器持有的缓存内存大小。                           |
12| hidebug.getPss                     | 获取应用进程实际使用的物理内存大小。                         |
13| hidebug.getVss                     | 获取应用进程虚拟耗用内存大小。                               |
14| hidebug.getSharedDirty             | 获取进程的共享脏内存大小。                                   |
15| hidebug.getPrivateDirty            | 获取进程的私有脏内存大小。                                   |
16| hidebug.getCpuUsage                | 获取进程的CPU使用率。                                        |
17| hidebug.dumpJsHeapData             | 虚拟机堆导出。                                               |
18| hidebug.startJsCpuProfiling        | 启动虚拟机Profiling方法跟踪。                                |
19| hidebug.stopJsCpuProfiling         | 停止虚拟机Profiling方法跟踪。                                |
20| hidebug.getAppVMMemoryInfo         | 获取VM内存相关信息。                                         |
21| hidebug.getAppThreadCpuUsage       | 获取应用线程CPU使用情况。                                    |
22| hidebug.startAppTraceCapture       | 启动应用trace采集。                                          |
23| hidebug.stopAppTraceCapture        | 停止应用trace采集。                                          |
24| hidebug.getAppMemoryLimit          | 获取应用程序进程内存限制。                                   |
25| hidebug.getSystemCpuUsage          | 获取系统的CPU资源占用情况。                                  |
26| hidebug.setAppResourceLimit        | 设置应用的fd数量、线程数量、js内存或者native内存资源限制。   |
27| hidebug.getAppNativeMemInfo        | 获取应用进程内存信息。                                       |
28| hidebug.getSystemMemInfo           | 获取系统内存信息。                                           |
29| hidebug.getVMRuntimeStats          | 获取系统gc全部统计信息。                                     |
30| hidebug.getVMRuntimeStat           | 根据参数获取指定的系统gc统计信息。                           |
31| hidebug.getGraphicsMemory          | 使用异步方式获取应用显存大小。                    |
32| hidebug.getGraphicsMemorySync      | 使用同步方式获取应用显存大小。                    |
33
34HiDebug的具体用法可查看API参考[API参考文档](../reference/apis-performance-analysis-kit/js-apis-hidebug.md)。
35
36## 开发示例
37
38下文将展示如何在应用内增加一个按钮，并单击该按钮以调用hidebug接口。
39
401. 新建一个工程，选择“Empty Ability”。
41
422. 工程配置界面中，**Model**选择“Stage”。
43
443. 在**Project**窗口单击entry > src > main > ets > pages，打开工程中的Index.ets文件，
45
46   新增一个方法调用hidebug接口，本文以hidebug.getSystemCpuUsage()为例，其他接口可参考[API参考文档](../reference/apis-performance-analysis-kit/js-apis-hidebug.md)。
47
48   ```ts
49   import { hidebug, hilog } from '@kit.PerformanceAnalysisKit';
50   function testHidebug(event?: ClickEvent) {
51     hilog.info(0x0000, "testTag", `getCurrentCpuUsage ${hidebug.getSystemCpuUsage()}`);
52   }
53   ```
54
55   给文本Text组件添加一个点击事件，示例代码如下：
56
57   ```ts
58   @Entry
59   @Component
60   struct Index {
61     @State message: string = 'Hello World'
62
63     build() {
64       Row() {
65         Column() {
66           Text(this.message)
67             .fontSize(50)
68             .fontWeight(FontWeight.Bold)
69             .onClick(testHidebug);//添加点击事件
70         }
71         .width('100%')
72       }
73       .height('100%')
74     }
75   }
76   ```
77
784. 在真机上运行该工程，单击应用/服务界面上的“Hello World”文本。
79
805. 在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件为“testTag”。
81   此时窗口将显示通过hidebug.getSystemCpuUsage()接口获取的CPU使用率的相关日志。
82   ```Text
83	06-25 19:50:27.485 24645-24645/com.example.myapplication I A00000/testTag: getCurrentCpuUsage 0.10164512338425381
84   ```
85
86<!--RP1-->
87<!--RP1End-->