Debug调试

2024-01-23 17:17 更新
说明

本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

使用hidebug,可以获取应用内存的使用情况,包括应用进程的静态堆内存(native heap)信息、应用进程内存占用PSS(Proportional Set Size)信息等;可以完成虚拟机内存切片导出,虚拟机CPU Profiling采集等操作。

导入模块

  1. import hidebug from '@ohos.hidebug';

hidebug.getNativeHeapSize

getNativeHeapSize(): bigint

获取本应用堆内存的总大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回本应用堆内存总大小,单位为Byte。

示例:

  1. let nativeHeapSize = hidebug.getNativeHeapSize();

hidebug.getNativeHeapAllocatedSize

getNativeHeapAllocatedSize(): bigint

获取本应用堆内存的已分配内存大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回本应用堆内存的已分配内存,单位为Byte。

示例:

  1. let nativeHeapAllocatedSize = hidebug.getNativeHeapAllocatedSize();

hidebug.getNativeHeapFreeSize

getNativeHeapFreeSize(): bigint

获取本应用堆内存的空闲内存大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回本应用堆内存的空闲内存,单位为Byte。

示例:

  1. let nativeHeapFreeSize = hidebug.getNativeHeapFreeSize();

hidebug.getPss

getPss(): bigint

获取应用进程实际使用的物理内存大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回应用进程实际使用的物理内存大小,单位为kB。

示例:

  1. let pss = hidebug.getPss();

hidebug.getSharedDirty

getSharedDirty(): bigint

获取进程的共享脏内存大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回进程的共享脏内存大小,单位为kB。

示例:

  1. let sharedDirty = hidebug.getSharedDirty();

hidebug.getPrivateDirty9+

getPrivateDirty(): bigint

获取进程的私有脏内存大小。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

bigint

返回进程的私有脏内存大小,单位为kB。

示例:

  1. let privateDirty = hidebug.getPrivateDirty();

hidebug.getCpuUsage9+

getCpuUsage(): number

获取进程的CPU使用率。

如占用率为50%,则返回0.5。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值:

类型

说明

number

获取进程的CPU使用率。

示例:

  1. let cpuUsage = hidebug.getCpuUsage();

hidebug.getServiceDump9+

getServiceDump(serviceid : number, fd : number, args : Array<string>) : void

获取系统服务信息。

需要权限: ohos.permission.DUMP

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

serviceid

number

基于该用户输入的service id获取系统服务信息。

fd

number

文件描述符,该接口会往该fd中写入数据。

args

Array<string>

系统服务的Dump接口所对应的参数列表。

示例:

  1. import fileio from '@ohos.fileio'
  2. import hidebug from '@ohos.hidebug'
  3. import featureAbility from '@ohos.ability.featureAbility'
  4. let context = featureAbility.getContext();
  5. context.getFilesDir().then((data) => {
  6. var path = data + "/serviceInfo.txt"
  7. console.info("output path: " + path)
  8. let fd = fileio.openSync(path, 0o102, 0o666)
  9. var serviceId = 10
  10. var args = new Array("allInfo")
  11. try {
  12. hidebug.getServiceDump(serviceId, fd, args)
  13. } catch (error) {
  14. console.info(error.code)
  15. console.info(error.message)
  16. }
  17. fileio.closeSync(fd);
  18. })

hidebug.startJsCpuProfiling9+

startJsCpuProfiling(filename : string) : void

启动虚拟机Profiling方法跟踪,startJsCpuProfiling()方法的调用需要与stopJsCpuProfiling()方法的调用一一对应,先开启后关闭,严禁使用start->start->stop,start->stop->stop,start->start->stop->stop等类似的顺序调用。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

filename

string

用户自定义的profiling文件名,根据传入的filename,将在应用的files目录生成filename.json文件。

示例:

  1. import hidebug from '@ohos.hidebug'
  2. try {
  3. hidebug.startJsCpuProfiling("cpu_profiling");
  4. // ...
  5. hidebug.stopJsCpuProfiling();
  6. } catch (error) {
  7. console.info(error.code)
  8. console.info(error.message)
  9. }

hidebug.stopJsCpuProfiling9+

stopJsCpuProfiling() : void

停止虚拟机Profiling方法跟踪,startJsCpuProfiling()方法的调用需要与stopJsCpuProfiling()方法的调用一一对应,先开启后关闭,严禁使用start->start->stop,start->stop->stop,start->start->stop->stop等类似的顺序调用。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

filename

string

用户自定义的profiling文件名,根据传入的filename,将在应用的files目录生成filename.json文件。

示例:

  1. import hidebug from '@ohos.hidebug'
  2. try {
  3. hidebug.startJsCpuProfiling("cpu_profiling");
  4. // ...
  5. hidebug.stopJsCpuProfiling();
  6. } catch (error) {
  7. console.info(error.code)
  8. console.info(error.message)
  9. }

hidebug.dumpJsHeapData9+

dumpJsHeapData(filename : string) : void

虚拟机堆导出。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

filename

string

用户自定义的虚拟机堆文件名,根据传入的filename,将在应用的files目录生成filename.heapsnapshot文件。

示例:

  1. import hidebug from '@ohos.hidebug'
  2. try {
  3. hidebug.dumpJsHeapData("heapData");
  4. } catch (error) {
  5. console.info(error.code)
  6. console.info(error.message)
  7. }

hidebug.startProfiling(deprecated)

startProfiling(filename : string) : void

说明

从 API version 9 开始废弃,建议使用hidebug.startJsCpuProfiling替代。

启动虚拟机Profiling方法跟踪,startProfiling()方法的调用需要与stopProfiling()方法的调用一一对应,先开启后关闭,严禁使用start->start->stop,start->stop->stop,start->start->stop->stop等类似的顺序调用。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

filename

string

用户自定义的profiling文件名,根据传入的filename,将在应用的files目录生成filename.json文件。

示例:

  1. hidebug.startProfiling("cpuprofiler-20220216");
  2. // code block
  3. // ...
  4. // code block
  5. hidebug.stopProfiling();

hidebug.stopProfiling(deprecated)

stopProfiling() : void

说明

从 API version 9 开始废弃,建议使用hidebug.stopJsCpuProfiling替代。

停止虚拟机Profiling方法跟踪,stopProfiling()方法的调用需要与startProfiling()方法的调用一一对应,先开启后关闭,严禁使用start->start->stop,start->stop->stop,start->start->stop->stop等类似的顺序调用。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

示例:

  1. hidebug.startProfiling("cpuprofiler-20220216");
  2. // code block
  3. // ...
  4. // code block
  5. hidebug.stopProfiling();

hidebug.dumpHeapData(deprecated)

dumpHeapData(filename : string) : void

说明

从 API version 9 开始废弃,建议使用hidebug.dumpJsHeapData替代。

虚拟机堆导出。

系统能力: SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数:

参数名

类型

必填

说明

filename

string

用户自定义的虚拟机堆文件名,根据传入的filename,将在应用的files目录生成filename.heapsnapshot文件。

示例:

  1. hidebug.dumpHeapData("heap-20220216");
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号