meminsight-test-demo 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,36 @@
+# ByteFun MemInsight
+![](https://img.shields.io/badge/license-Apache%202-green.svg)
+[![](https://img.shields.io/badge/env-Node16.x+-blue.svg)](https://nodejs.org/en/download/)
+[![](https://img.shields.io/badge/lang-TypeScript-orange.svg)](https://www.typescriptlang.org/download/)
+
+ByteFun MemInsight 是面向鸿蒙生态伙伴的一款开源内存分析引擎，包含meminsight命令行工具和npm包等组件。
+
+## 快速开始
+
+[**User Guide**](./docs/UserGuide.md)
+
+## 框架介绍
+
+![](./docs/resources/framework.png)
+
+## 功能介绍
+
+### 快照解析器
+
+![](./docs/resources/analyzer.png)
+
+#### 【StatisticAnalyzer】支持内存快照统计分析
+适用场景：单快照分析
+
+#### 【CompareAnalyzer】支持内存快照比较分析
+适用场景：双快照分析
+
+#### 【XAnalyzer】支持内存快照统计&聚合分析
+适用场景：单快照/多快照统计&聚合分析
+
+#### 【LeakAnalyzer】支持内存快照泄露分析（待规划）
+适用场景：多快照分析
+
+## 构建编译
+
+[构建编译指导链接](./docs/Build.md)

package/docs/Build.md

@@ -0,0 +1,68 @@
+# ByteFun MemInsight 构建
+
+构建支持命令行工具和 npm 包两种方式。
+
+## 构建步骤
+
+1. 安装 node 环境，node 版本要求 >= 16.x, npm  版本要求 >= 7.x
+
+2. Git 下载 MemInsight 代码仓
+
+3. 进入 MemInsight 目录，执行 npm install
+
+4. 执行 npm run build
+
+5. 构建成功，
+ 
+   (1) npm 包生成在 ./node_modules/@meminsight 目录下
+
+   (2) npm 包生成在 .packages/core/dist 和 .packages/meminsight/dist 目录下
+
+6. 执行 npm run pkg-meminsight
+
+7. 构建成功，命令行工具生成在 ./dist 目录下，是一个可执行文件 meminsight
+
+## 构建说明
+
+### 运行 npm run build 失败，请重新执行 npm install
+
+可以依次执行以下命令：
+
+```bash
+npm run clean-all
+npm install
+npm run build
+```
+
+### 运行 npm run pkg-meminsight 失败，请检查 pkg 是否安装成功
+
+（1）执行以下命令并检查 pkg 版本
+
+```bash
+$ npm install -g pkg
+$ pkg --version
+5.8.1
+```
+
+（2）打包可执行文件 meminsight
+```bash
+$ npm run pkg-meminsight
+
+> meminsight@1.0.0 pkg
+> pkg -t node18 --output=./dist/meminsight --public -C GZip packages/meminsight/package.json
+
+> pkg@5.8.1
+compression:  GZip
+...
+```
+在工程根目录下 dist 文件夹下生成 meminsight 可执行文件。
+
+### npm run pkg-meminsight 显示版本不匹配
+
+```bash
+Error: Failed to load bindings
+Error: The module was compiled against a different Node.js version
+```
+
+升级或降级 pkg 到与当前 Node.js 兼容的版本.
+如本工程 pkg 版本为 5.8.1，Node.js 版本为 16.19.1

package/docs/Interface.md

@@ -0,0 +1,35 @@
+## ByteFun MemInsight MemInsight Analyzer Interfaces
+| 接口 | 参数 |
+|----|----|
+|analyze(args: any[]) : Promise<any>|args: any[]：heapsnapshot文件路径|
+|setConfig(cfg: any) : void|cfg: any 不同分析器 cfg 不同|
+|getConfig(): any|获取解析器配置|
+|getGCRoots() : Promise<Array<IHeapNode>>|获取所有GC根节点|
+|getDetachedNodes() : Promise<Array<IHeapNode>>|获取所有分离节点|
+|getNodesByConfig() : Promise<Array<IHeapNode>>|获取所有符合配置条件的节点|
+|getArkNodesMap(...): Promise<ArkNodesMap>|参数见描述 [链接](#getarknodesmap)|
+
+## getArkNodesMap
+### 参数列表：
+```typescript
+nameWhiteList: string[],
+typeWhiteList: string[] = ['object'],
+enableShortestPath: boolean = true,
+enableAggrationPath: boolean = true,
+maxAggrationLength = 3,
+enableMinRetainedSize = false,
+minRetainedSize = 1024 * 1024,
+descending: boolean = true
+```
+### 参数描述
+```typescript
+nameWhiteList: 节点名称白名单，空则包含所有节点名称；typeWhiteList: 节点类型白名单，必填字段；
+enableShortestPath: 是否分析最短引用路径
+enableAggrationPath: 是否聚合引用路径
+maxAggrationLength: 筛选的最大最短引用路径个数
+enableMinRetainedSize: 是否按retained size阈值过滤最短引用路径
+minRetainedSize: retained size阈值
+descending: 是否按引用次数降序获取聚合路径，默认true
+getArkNodesMapByConfig() : Promise<ArkNodesMap | undefined>
+根据配置获取符合条件的节点信息，包括最短引用路径聚合路径信息
+```

package/docs/UserGuide.md

@@ -0,0 +1,332 @@
+# ByteFun MemInsight 使用介绍
+
+## meminsight 命令行工具
+
+meminsight 命令行工具是一个基于node的可执行文件，使用简单方便。
+
+### help
+
+```bash
+$./meminsight -h
+Usage: meminsight [options] [command]
+
+meminsight binary is a command tool for memory analysis.
+
+Options:
+  -v, --version          meminsight version
+  -h, --help             display help for command
+
+Commands:
+  ark-stat [options]     ark statistic analysis process.
+  ark-compare [options]  ark compare process.
+  ark-leak [options]     ark leaks analysis process.
+  ark-gc [options]       ark force gc process.
+  ark-x [options]        ark-x analysis process.
+  help [command]         display help for command
+```
+
+### ark-stat
+
+```bash
+$ ./dist/meminsight ark-stat -h
+Usage: meminsight ark-stat [options]
+
+ark statistic analysis process.
+
+Options:
+  -t, --target <target heapsnapshot file>  target heapsnapshot file
+  -m, --mode <mode type>                   
+  mode type:
+        1: get all detached nodes
+        2: get all gc roots
+        3: get node shortest path, node id is required
+        4: get node aggration paths by configuration => Not Support
+        5: get node by configuration
+        6: get shared heap nodes. => Not Support
+  
+  -i, --node_id <node id>                  node id
+  -c, --config <configuration file>        configuration file
+  -o, --output <output folder path>        output folder path (default: "./output")
+  -f, --output_file <output file type>     output file type, console | txt | json | html. (default: "console")
+  -h, --help                               display help for command
+```
+### 示例
+
+1. 获取指定快照 Detached Nodes 并保存到 txt 文件
+
+```bash
+$ ./meminsight ark-stat -t ../files/1.heapsnapshot -m 1 -i 1 -o ./output -f txt
+ | 2025-05-12T09:56:45.032 | [INFO] | meminsight-ArkStatProc: Analyzed successfully.
+ | 2025-05-12T09:56:45.034 | [WARN] | meminsight-ArkStatProc: No configuration found, use default config.
+ ......
+ | 2025-05-12T09:56:45.036 | [INFO] | meminsight-ArkStatProc: Set configuration successfully.
+ | 2025-05-12T09:56:45.036 | [INFO] | meminsight-ArkStatProc: mode:1; output:./output; type:txt
+```
+生成的 txt 文件如下，每一行包含了节点信息。
+
+![](./resources/filetype_txt.png)
+
+2. 获取指定快照 GC Roots 并 console 打印
+
+```bash
+$ ./meminsight ark-stat -t ../files/1.heapsnapshot -m 2 -f console
+ | 2025-05-12T09:55:15.421 | [INFO] | meminsight-ArkStatProc: Analyzed successfully.
+ | 2025-05-12T09:55:15.422 | [WARN] | meminsight-ArkStatProc: No configuration found, use default config.
+ ......
+ | 2025-05-12T09:55:15.425 | [INFO] | meminsight-ArkStatProc: Set configuration successfully.
+ | 2025-05-12T09:55:15.425 | [INFO] | meminsight-ArkStatProc: mode:2; output:./output; type:console
+{
+  FilePath: '../files/1.heapsnapshot',
+  'Action:': 'Get GC Roots',
+  NodeLength: 4,
+  Time: 1747043715436
+}
+┌─────────┬────────┬─────────────┬───────────────────────┐
+│ (index) │   id   │    type     │         name          │
+├─────────┼────────┼─────────────┼───────────────────────┤
+│    0    │   1    │ 'synthetic' │          ''           │
+│    1    │ 161260 │  'native'   │    'InternalNode'     │
+│    2    │ 215678 │  'native'   │    'InternalNode'     │
+│    3    │ 228378 │  'native'   │ 'PerformanceObserver' │
+└─────────┴────────┴─────────────┴───────────────────────┘
+```
+3. 按配置文件获取指定节点，以 json 文件输出
+
+配置文件通过 -c 或 --config 指定文件路径，注意每一类解析器配置文件不同，如 ark-stat 的配置文件参照 ./packages/cfg/ArkStatCfg.json
+
+```bash
+$ ./meminsight ark-stat -t ../files/1.heapsnapshot -m 5 -c ./packages/cfg/ArkStatCfg.json -f json
+ | 2025-05-12T10:06:05.337 | [INFO] | meminsight-ArkStatProc: Analyzed successfully.
+ ......
+ | 2025-05-12T10:06:05.341 | [INFO] | meminsight-ArkStatProc: Set configuration successfully.
+ | 2025-05-12T10:06:05.341 | [INFO] | meminsight-ArkStatProc: mode:5; output:./output; type:json
+```
+生成的 json 文件只包含按配置文件中定义的过滤器过滤的节点，可以按 json 解析，包含 meta 和 data 两部分。
+
+![](./resources/cfg_filter_filetype_json.png)
+
+4. 获取指定节点的最短引用路径，并 console 打印
+
+5. 获取聚合引用路径信息，并 json 保存
+
+6. 获取共享内存对象信息
+
+### ark-compare(快照比较分析器)
+
+```bash
+$ meminsight ark-compare -h
+Usage: meminsight ark-compare [options]
+
+ark compare process.
+
+Options:
+  -s, --source <file>                                                         source heapsnapshot file
+  -t, --target <file>                                                         target heapsnapshot file
+  -n, --node_name <node name>
+  -S, --sort_type <sort type: 0 - count | 1 - self_size | 2 - retained_size>  sort type (default: 0)
+  -c, --config <configuration file>                                           configuration file
+  -o, --output <file>                                                         output file
+  -f, --output_file <file type>                                               output file type, console | text | json | html.
+  -h, --help                                                                  display help for command                             display help for command
+```
+### 示例
+
+1. 比较获取两个快照的差异
+
+```bash
+$ ./meminsight ark-compare -s ../files/3500-1.heapsnapshot -t ../files/3501-1.heapsnapshot -S 0 
+...
+{
+    typeName: 'js_weak_ref',
+    srcCount: 13707,
+    dstCount: 20420,
+    countDiff: 6713,
+    srcSelfSize: 986904,
+    dstSelfSize: 1470240,
+    selfSizeDiff: 483336,
+    ...
+  },
+  {
+    typeName: 'js_bound_function',
+    srcCount: 12147,
+    dstCount: 5666,
+    countDiff: -6481,
+    srcSelfSize: 1360464,
+    dstSelfSize: 634592,
+    selfSizeDiff: -725872,
+    ...
+  },
+  ...
+```
+
+### ark-x (统计&聚合分析器)
+
+```bash
+$ ./meminsight ark-x -h
+Usage: meminsight ark-x [options]
+
+ark-x analysis process.
+
+Options:
+  -f, --file <filepath>       target filepath (default: "")
+  -l, --list <list filepath>  one list file which contains snapshot filepathes (default: "")
+  -s, --sort <sort tyoe>      sort type, 0 - by retained size | 1 - by count (default: 0)
+  -T, --top <top number>      top number, default is 10 (default: 10)
+  -t, --tags <object tags>    tobject tags, as tag1,tag2,tag3... (default: "")
+  -h, --help                  display help for command
+```
+
+### 示例
+
+1. 单个快照统计&聚合
+
+```bash
+$ ./meminsight ark-x --file=../files/1000-1.heapsnapshot
+Heapsnapshot Files:
+/Users/files/1000-1.heapsnapshot
+Start to parse heapsnapshot:  /Users/files/1000-1.heapsnapshot
+Success to parse heapsnapshot:  /Users/files/1000-1.heapsnapshot
+
+
+========================JSObject 对象按 Distance 统计=========================
+
+Total Heap Size: 281.53 MB
+Total JSObject Self Size: 19362.06 KB, Ratio: 6.72%
+Total JSObject Retained Size: 142997.51 KB, Ratio: 49.60%
+Total JSObject Count: 316278
+...
+```
+
+2. 多个快照统计&聚合
+
+- 将多个快照的绝对路径写入一个 list 文本文件，如下
+建议快照命名格式按 "version-index.heapsnapshot" 命名
+```
+/Users/files/1000-1.heapsnapshot
+/Users/files/2001-1.heapsnapshot
+```
+
+```bash
+$ ./meminsight ark-x --list=../files/list.txt
+...
+Heapsnapshot Files:
+/Users/files/1000-1.heapsnapshot
+/Users/files/2000-1.heapsnapshot
+Start to parse heapsnapshot:  /Users/files/1000-1.heapsnapshot
+Success to parse heapsnapshot:  /Users/files/2000-1.heapsnapshot
+
+
+========================JSObject 对象按 Distance 统计=========================
+
+Total Heap Size: 281.53 MB
+Total JSObject Self Size: 19362.06 KB, Ratio: 6.72%
+Total JSObject Retained Size: 142997.51 KB, Ratio: 49.60%
+Total JSObject Count: 316278
+...
+```
+
+3. 指定 TopN 统计&聚合
+
+```bash
+$ ./meminsight ark-x --top=5 --file=../files/1000-1.heapsnapshot
+...
+Info By Count:
+Index-1, ShortestPath: source_text_module_record <- SyntheticRoot,
+    Count: 120224, 
+    Retained Size: 52273.79 KB, 
+    RetainedSizeTotalHeapPercent: 18.13%,
+    Shallow Size: 5966.40 KB, 
+    ShallowSizeTotalHeapPercent: 2.07%
+Index-2, ShortestPath: JSObject <- JSObject <- SyntheticRoot,
+    Count: 78034, 
+    Retained Size: 5540.46 KB, 
+    RetainedSizeTotalHeapPercent: 1.92%,
+    Shallow Size: 2475.16 KB, 
+    ShallowSizeTotalHeapPercent: 0.86%
+Index-3, ShortestPath: cow_tagged_array <- class_literal <- constant_pool <- SyntheticRoot,
+    Count: 26680, 
+    Retained Size: 902.73 KB, 
+    RetainedSizeTotalHeapPercent: 0.31%,
+    Shallow Size: 902.73 KB, 
+    ShallowSizeTotalHeapPercent: 0.31%
+Index-4, ShortestPath: importentry_record <- tagged_array <- source_text_module_record <- SyntheticRoot,
+    Count: 25133, 
+    Retained Size: 824.41 KB, 
+    RetainedSizeTotalHeapPercent: 0.29%,
+    Shallow Size: 824.41 KB, 
+    ShallowSizeTotalHeapPercent: 0.29%
+Index-5, ShortestPath: tagged_dictionary <- JSObject <- constant_pool <- SyntheticRoot,
+    Count: 24564, 
+    Retained Size: 603.82 KB, 
+    RetainedSizeTotalHeapPercent: 0.21%,
+    Shallow Size: 603.82 KB, 
+    ShallowSizeTotalHeapPercent: 0.21%
+...
+```
+
+4. 指定排序方式获取TopN的统计&聚合（按大小排序/按个数排序）
+
+通过 --sort 来设置排序方式
+
+```bash
+-s, --sort <sort tyoe>      sort type, 0 - by retained size | 1 - by count (default: 0)
+```
+
+```bash
+# 按大小排序
+$ ./meminsight ark-x --top=5 --file=../files/1000-1.heapsnapshot --sort=1
+...
+Info By Count:
+Index-1, ShortestPath: source_text_module_record <- SyntheticRoot,
+    Count: 120224, 
+    Retained Size: 52273.79 KB, 
+    RetainedSizeTotalHeapPercent: 18.13%,
+    Shallow Size: 5966.40 KB, 
+    ShallowSizeTotalHeapPercent: 2.07%
+Index-2, ShortestPath: JSObject <- JSObject <- SyntheticRoot,
+    Count: 78034, 
+    Retained Size: 5540.46 KB, 
+    RetainedSizeTotalHeapPercent: 1.92%,
+    Shallow Size: 2475.16 KB, 
+    ShallowSizeTotalHeapPercent: 0.86%
+Index-3, ShortestPath: cow_tagged_array <- class_literal <- constant_pool <- SyntheticRoot,
+    Count: 26680, 
+    Retained Size: 902.73 KB, 
+    RetainedSizeTotalHeapPercent: 0.31%,
+    Shallow Size: 902.73 KB, 
+    ShallowSizeTotalHeapPercent: 0.31%
+Index-4, ShortestPath: importentry_record <- tagged_array <- source_text_module_record <- SyntheticRoot,
+    Count: 25133, 
+    Retained Size: 824.41 KB, 
+    RetainedSizeTotalHeapPercent: 0.29%,
+    Shallow Size: 824.41 KB, 
+    ShallowSizeTotalHeapPercent: 0.29%
+Index-5, ShortestPath: tagged_dictionary <- JSObject <- constant_pool <- SyntheticRoot,
+    Count: 24564, 
+    Retained Size: 603.82 KB, 
+    RetainedSizeTotalHeapPercent: 0.21%,
+    Shallow Size: 603.82 KB, 
+    ShallowSizeTotalHeapPercent: 0.21%
+...
+```
+
+5. 类名中包含指定标签的统计&聚合
+
+- 通过 --tags 设置标签
+- 多个标签通过 “，” 分隔，如 “--tags=tag1,tag2,tag3”
+
+```bash
+$ ./meminsight ark-x --file=../files/1000-1.heapsnapshot --tags=tag1,tag2
+
+...
+```
+
+## npm 包
+
+### analyzer
+
+[](./resources/analyzer.png)
+
+### 接口说明
+
+参见文档 [Interface](./Interface.md)