订阅系统事件（资源泄漏事件）

HiAppEvent提供接口用于订阅系统资源泄漏事件。

接口说明

API接口的具体使用说明（参数使用限制、具体取值范围等）请参考应用事件打点API文档。

接口名 描述
addWatcher(watcher: Watcher): AppEventPackageHolder 添加应用事件观察者，以添加对应用事件的订阅。
removeWatcher(watcher: Watcher): void 移除应用事件观察者，以移除对应用事件的订阅。

资源泄漏事件信息中params属性的详细描述如下：

params属性：

名称 类型 说明
time number 事件触发时间，单位为毫秒。
bundle_version string 应用版本。
bundle_name string 应用名称。
pid number 应用的进程id。
uid number 应用的用户id。
resource_type string 资源类型，取值范围详见resource_type属性。
memory object 内存信息，详见memory属性。

resource_type属性：

取值 说明
pss_memory pss内存泄漏。
js_memory js内存泄漏。
fd fd资源泄漏。
thread 线程泄漏

memory属性：

名称 类型 说明
rss number 进程实际占用内存大小，单位KB。
vss number 进程向系统申请的虚拟内存大小，单位KB。
pss number 进程实际使用的物理内存大小，单位KB。
sys_free_mem number 空闲内存大小，单位KB。
sys_avail_mem number 可用内存大小，单位KB。
sys_total_mem number 总内存大小，单位KB。

开发步骤

以实现对发生内存泄漏场景生成的资源泄漏事件订阅为例，说明开发步骤。

  1. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，完整示例代码如下：

     hiAppEvent.addWatcher({
   // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
   name: "watcher3",
   // 开发者可以订阅感兴趣的系统事件，此处是订阅了资源泄漏事件
   appEventFilters: [
     {
       domain: hiAppEvent.domain.OS,
       names: [hiAppEvent.event.RESOURCE_OVERLIMIT]
     }
   ],
   // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
   onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
     hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
     for (const eventGroup of appEventGroups) {
       // 开发者可以根据事件集合中的事件名称区分不同的系统事件
       hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
       for (const eventInfo of eventGroup.appEventInfos) {
         // 开发者可以获取到资源泄漏事件发生时内存信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo)}`);
       }
     }
   }
 });

  2. 运行hdc shell param set hiview.memleak.test enable，使能内存泄漏检测测试，原泄漏检测周期为200s，使能后，周期为5s。

    运行hdc shell killall hiview，重启hiview，使能内存检测测试才会生效。

  3. 点击IDE界面中的运行按钮，运行应用工程，hiview连续5次检测到应用内存超基线（RSS超过1228800KB），会上报应用内存泄漏事件。 同一个应用，5小时内至多上报一次内存泄漏，如果短时间内要二次上报，需要重启hiview

  4. 内存泄漏事件上报后，系统会回调应用的onReceive函数，可以在Log窗口看到对系统事件数据的处理日志：

    HiAppEvent onReceive: domain=OS
HiAppEvent eventName=RESOURCE_OVERLIMIT
HiAppEvent eventInfo={"domain":"OS","name":"RESOURCE_OVERLIMIT","eventType":1,"params":{"bundle_name":"com.example.myapplication","bundle_version"::"1.0.0","memory":{"pss":2100257,"rss":1352644,"sys_avail_mem":250272,"sys_free_mem":60004,"sys_total_mem":1992340,"vss":2462936},"pid":20731,"resource_type":"pss_memory","time":1502348798106,"uid":20010044}}