智能客服
你问我答,随时在线为你解决问题
为方便开发者定位问题,应用在ArkTS内存OOM(Out of Memory)时会自动进行HeapDump。此操作会将虚拟机当前堆上的所有对象信息保存在后缀为.rawheap的二进制文件中。此外,使用接口hidebug.dumpJsRawHeapData能获取当前线程的rawheap文件,或使用命令行hidumper --mem-jsheap pid [-T tid] --raw能主动获取指定进程或指定JS线程的rawheap文件。开发者可使用rawheap_translator工具解析.rawheap文件,生成.heapsnapshot文件。该文件可通过DevEco Studio的Heap Snapshot离线导入或Chrome浏览器的开发者工具中的内存工具导入并查看。
此工具支持Windows、Linux和MacOS平台,获取方法如下:
建议将从SDK中获取的rawheap_translator工具放置在稳定的路径下,并将该路径配置为系统环境变量。这样可以在终端中直接使用工具,无需每次指定路径。
在不同系统中,环境变量的配置方法存在差异。以下提供一些配置示例,供开发者参考。
Windows环境变量设置方法(以Windows 10某版本为例)。
MacOS环境变量设置方法(以MacOS 15某版本为例)。
打开终端工具,执行以下命令。
- echo $SHELL
根据步骤1的返回结果做如下对应处理。
a. 如果返回结果为/bin/bash,则执行以下命令:
- echo 'export PATH=$PATH:/path/to/your/rawheap_translator' >> ~/.bash_profile
- source ~/.bash_profile
b. 如果返回结果为/bin/zsh,则执行以下命令:
- echo 'export PATH=$PATH:/path/to/your/rawheap_translator' >> ~/.zshrc
- source ~/.zshrc
- rawheap_translator [rawheap_file] [heapsnapshot_file]
| 选项 | 必选 | 描述 |
|---|---|---|
| [rawheap_file] | 是 | 需要解析的应用OOM时生成的.rawheap文件路径。 |
| [heapsnapshot_file] | 否 | 解析生成的heapsnapshot文件路径,路径必须具有读写权限。 参数缺省时,默认为当前执行命令的路径,生成文件名为hprof_yyyy-MM-dd-HH-mm-ss.heapsnapshot,其中yyyy-MM-dd-HH-mm-ss为当前解析文件的时间。 参数给定时,文件的后缀名必须是heapsnapshot。 |
Windows系统中解析示例
打开cmd并进入rawheap文件路径,调用解析工具命令,指定在当前路径下生成heapsnapshot文件。
- > rawheap_translator.exe memleak-js-com.example.myapplication-7979-7979-20241215191332.rawheap myapplication-7979-7979.heapsnapshot
Linux系统中解析示例
进入rawheap文件路径,调用解析工具命令,指定在当前路径下生成heapsnapshot文件。
- > rawheap_translator memleak-js-com.example.myapplication-7979-7979-20241215191332.rawheap myapplication-7979-7979.heapsnapshot
MacOS系统中解析示例
打开终端并进入rawheap文件路径,调用解析工具命令,指定在当前路径下生成heapsnapshot文件。
- > rawheap_translator memleak-js-com.example.myapplication-7979-7979-20241215191332.rawheap myapplication-7979-7979.heapsnapshot
参考输出
- [INFO ] ParseVersion current metadata version is 1.0.0
- [INFO ] ParseTypeEnums total JSType count 214
- [INFO ] ParseTypeList total metadata count 220
- [INFO ] SetBitField set BitField offset 8
- [INFO ] SetBitField set BindingSize offset 32
- [INFO ] SetBitField set Length offset 8
- [INFO ] SetBitField set Data offset 16
- [INFO ] ReadVersion current rawheap version is 1.0.0
- [INFO ] RawHeap start to translate rawheap
- [INFO ] ReadRootTable root node count 6244
- [INFO ] ReadStringTable string table count 11208
- [INFO ] ReadObjTable section objects count 96432
- [INFO ] Translate success
- [INFO ] Serialize start to serialize
- [INFO ] Translate file save to /data/local/tmp/myapplication-7979-7979.heapsnapshot
rawheap文件的大小和生成耗时与当前ArkTS堆内存大小及存活对象数量呈强正相关。当ArkTS堆内存占用较大、存活对象数量较多时,生成的rawheap文件会更大,耗时也会更长。开发者可以订阅资源泄漏事件,自定义事件处理逻辑。
从API version 20开始,虚拟机支持两种规格的HeapDump,具体切换操作可参考setJsRawHeapTrimLevel接口设置当前进程转储虚拟机原始堆快照的裁剪级别。
从API version 22开始,TRIM_LEVEL_1模式新增对象属性名解析能力,生成的rawheap文件相对于原先会变大,具体增长大小与对象属性名数量和字符串大小有关。
| 规格 | 特点 |
|---|---|
| TRIM_LEVEL_1 | dump速度快,生成的rawheap文件大。 API version 20之前版本,虚拟机默认为TRIM_LEVEL_1规格。 |
| TRIM_LEVEL_2 | dump速度稍慢,生成的rawheap文件大小相比TRIM_LEVEL_1缩小40%左右。 |
为了方便开发者了解上报rawheap文件到服务器所带来的性能和流量开销,下表给出了在不同的堆大小下,不同规格的HeapDump生成的rawheap文件大小、生成耗时、解析耗时的示例,仅供开发者参考。
| 规格 | 堆大小(MB) | rawheap文件(MB) | 生成耗时(s) | 解析耗时(s) |
|---|---|---|---|---|
| TRIM_LEVEL_1 | 690 | 629 | 2.64 | 14 |
| TRIM_LEVEL_2 | 690 | 376 | 3.47 | 14 |
| TRIM_LEVEL_1 | 653 | 618 | 2.63 | 13 |
| TRIM_LEVEL_2 | 653 | 347 | 3.36 | 13 |
| TRIM_LEVEL_1 | 576 | 563 | 3.63 | 15 |
| TRIM_LEVEL_2 | 576 | 294 | 4.53 | 15 |
问题现象
工具解析时会提示:原始堆文件的版本 2.0.0 与当前的原始堆文件翻译器不匹配,请使用最新版本的翻译器。
- [INFO ] ParseVersion current metadata version is 1.0.0
- [INFO ] ParseTypeEnums total JSType count 214
- [INFO ] ParseTypeList total metadata count 220
- [INFO ] SetBitField set BitField offset 8
- [INFO ] SetBitField set BindingSize offset 32
- [INFO ] SetBitField set Length offset 8
- [INFO ] SetBitField set Data offset 16
- [INFO ] ReadVersion current rawheap version is 2.0.0
- [ERROR] ParseRawheap The rawheap file's version 2.0.0 is not matched the current rawheap translator, please use the newest version of the translator!
原因
当前工具版本低于rawheap文件版本。
解决措施
升级工具版本至2.0.0可解决此问题。
问题现象
工具解析时,提示:open file failed
- [INFO ] ParseVersion current metadata version is 1.0.0
- [INFO ] ParseTypeEnums total JSType count 214
- [INFO ] ParseTypeList total metadata count 220
- [INFO ] SetBitField set BitField offset 8
- [INFO ] SetBitField set BindingSize offset 32
- [INFO ] SetBitField set Length offset 8
- [INFO ] SetBitField set Data offset 16
- [INFO ] ReadVersion current rawheap version is 1.0.0
- [INFO ] RawHeap start to translate rawheap
- [INFO ] ReadRootTable root node count 6244
- [INFO ] ReadStringTable string table count 11208
- [INFO ] ReadObjTable section objects count 96432
- [INFO ] Translate success
- [ERROR] Initialize open file failed
原因
指定的生成文件路径没有写入权限。
解决措施
更改到有写权限的路径可以解决。
问题现象
工具解析完成,进行转换时失败,未生成heapsnapshot文件。
- [INFO ] ParseVersion current metadata version is 1.0.0
- [INFO ] ParseTypeEnums total JSType count 214
- [INFO ] ParseTypeList total metadata count 220
- [INFO ] SetBitField set BitField offset 8
- [INFO ] SetBitField set BindingSize offset 32
- [INFO ] SetBitField set Length offset 8
- [INFO ] SetBitField set Data offset 16
- [INFO ] ReadVersion current rawheap version is 1.0.0
- [INFO ] RawHeap start to translate rawheap
- [INFO ] ReadRootTable root node count 6244
- [INFO ] ReadStringTable string table count 11208
- [INFO ] ReadObjTable section objects count 96432
原因
解析工具版本过低。
解决措施
使用DevEco Studio 6.1.1 Release及以上版本的工具。
智能客服
你问我答,随时在线为你解决问题
合作咨询
我们的专家服务团队将竭诚为您提供专业的合作咨询服务
解决方案
精准高效的一站式服务支持,助力开发者商业成功