未验证 提交 1edd68f9 编写于 作者: O openharmony_ci 提交者: Gitee

!1512 hidebug模块js-api文件添加

Merge pull request !1512 from jiangyuan0000/master
# Debug调试
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用hidebug,可以获取应用内存的使用情况,包括应用进程的静态堆内存(native heap)信息、应用进程内存占用PSS(Proportional Set Size)信息等;可以完成虚拟机内存切片导出,虚拟机CPU Profiling采集等操作。
## 导入模块
```
import hidebug from '@ohos.hidebug';
```
## 系统能力
SystemCapability.HiviewDFX.HiProfiler.HiDebug
## hidebug.getNativeHeapSize
getNativeHeapSize(): bigint
获取native heap内存的总大小。
- **返回值**
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回native heap内存总大小。 |
- 示例:
```
let nativeHeapSize = hidebug.getNativeHeapSize();
```
## hidebug.getNativeHeapAllocatedSize
getNativeHeapAllocatedSize(): bigint
获取native heap内存的已分配内存大小。
- **返回值**
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回native heap内存的已分配内存。 |
- 示例:
```
let nativeHeapAllocatedSize = hidebug.getNativeHeapAllocatedSize();
```
## hidebug.getNativeHeapFreeSize
getNativeHeapFreeSize(): bigint
获取native heap内存的空闲内存大小。
- **返回值**
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回native heap内存的空闲内存。 |
- 示例:
```
let nativeHeapFreeSize = hidebug.getNativeHeapFreeSize();
```
## hidebug.getPss
getPss(): bigint
获取应用进程PSS内存大小。
- **返回值**
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回应用进程PSS内存大小。 |
- 示例:
```
let pss = hidebug.getPss();
```
## hidebug.getSharedDirty
getSharedDirty(): bigint
获取进程的共享脏内存大小。
- **返回值**
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回进程的共享脏内存大小。 |
- 示例:
```
let sharedDirty = hidebug.getSharedDirty());
```
## hidebug.startProfiling
startProfiling(filename : string) : void
启动虚拟机Profiling方法跟踪,`startProfiling()`方法的调用需要与`stopProfiling()`方法的调用一一对应,先开启后关闭,严禁使用`start->start->stop``start->stop->stop``start->start->stop->stop`等顺序的调用方式。
* **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| filename | string | 是 | 用户自定义的profiling文件名,根据传入的`filename`,将在应用的`files`目录生成`filename.json`文件。 |
* **示例**
```js
hidebug.startProfiling("cpuprofiler-20220216");
// code block
// ...
// code block
hidebug.stopProfiling();
```
## hidebug.stopProfiling
stopProfiling() : void
停止虚拟机Profiling方法跟踪,`stopProfiling()`方法的调用需要与`startProfiling()`方法的调用一一对应,先开启后关闭,严禁使用`start->start->stop``start->stop->stop``start->start->stop->stop`等顺序的调用方式。
* **示例**
```js
hidebug.startProfiling("cpuprofiler-20220216");
// code block
// ...
// code block
hidebug.stopProfiling();
```
## hidebug.dumpHeapData
dumpHeapData(filename : string) : void
虚拟机堆导出。
* **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| filename | string | 是 | 用户自定义的虚拟机堆文件名,根据传入的`filename`,将在应用的`files`目录生成`filename.heapsnapshot`文件。 |
* **示例**
```js
hidebug.dumpHeapData("heap-20220216");
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册