1# 订阅系统事件（资源泄漏事件） 2 3HiAppEvent提供接口用于订阅系统资源泄漏事件。 4 5## 接口说明 6 7API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[应用事件打点API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。 8 9| 接口名 | 描述 | 10| --------------------------------------------------- | -------------------------------------------- | 11| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 | 12| removeWatcher(watcher: Watcher): void | 移除应用事件观察者，以移除对应用事件的订阅。 | 13 14资源泄漏事件信息中params属性的详细描述如下： 15 16**params属性：** 17 18| 名称 | 类型 | 说明 | 19| ------- | ------ | ------------------------- | 20| time | number | 事件触发时间，单位为毫秒。 | 21| bundle_version | string | 应用版本。 | 22| bundle_name | string | 应用名称。 | 23| pid | number | 应用的进程id。| 24| uid | number | 应用的用户id。 | 25| resource_type | string | 资源类型，取值范围详见resource_type属性。 | 26| memory | object | 内存信息，详见memory属性。 | 27 28**resource_type属性：** 29 30| 取值 | 说明 | 31| ------- | ------------------------- | 32| pss_memory | pss内存泄漏。 | 33| js_memory | js内存泄漏。 | 34| fd | fd资源泄漏。 | 35| thread | 线程泄漏 | 36 37**memory属性：** 38 39| 名称 | 类型 | 说明 | 40| ------- | ------ | ------------------------- | 41| rss | number | 进程实际占用内存大小，单位KB。 | 42| vss | number | 进程向系统申请的虚拟内存大小，单位KB。 | 43| pss | number | 进程实际使用的物理内存大小，单位KB。 | 44| sys_free_mem | number | 空闲内存大小，单位KB。 | 45| sys_avail_mem | number | 可用内存大小，单位KB。 | 46| sys_total_mem | number | 总内存大小，单位KB。 | 47 48## 开发步骤 49 50以实现对发生内存泄漏场景生成的资源泄漏事件订阅为例，说明开发步骤。 51 521. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，完整示例代码如下： 53 54 ```ts 55 hiAppEvent.addWatcher({ 56 // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者 57 name: "watcher3", 58 // 开发者可以订阅感兴趣的系统事件，此处是订阅了资源泄漏事件 59 appEventFilters: [ 60 { 61 domain: hiAppEvent.domain.OS, 62 names: [hiAppEvent.event.RESOURCE_OVERLIMIT] 63 } 64 ], 65 // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理 66 onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => { 67 hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`); 68 for (const eventGroup of appEventGroups) { 69 // 开发者可以根据事件集合中的事件名称区分不同的系统事件 70 hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`); 71 for (const eventInfo of eventGroup.appEventInfos) { 72 // 开发者可以获取到资源泄漏事件发生时内存信息 73 hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo)}`); 74 } 75 } 76 } 77 }); 78 ``` 79 802. 运行`hdc shell param set hiview.memleak.test enable`，使能内存泄漏检测测试，原泄漏检测周期为200s，使能后，周期为5s。 81 82 运行`hdc shell killall hiview`，重启hiview，使能内存检测测试才会生效。 83 843. 点击IDE界面中的运行按钮，运行应用工程，hiview连续5次检测到应用内存超基线（RSS超过1228800KB），会上报应用内存泄漏事件。 85 同一个应用，5小时内至多上报一次内存泄漏，如果短时间内要二次上报，需要重启hiview 86 874. 内存泄漏事件上报后，系统会回调应用的onReceive函数，可以在Log窗口看到对系统事件数据的处理日志： 88 89 ```text 90 HiAppEvent onReceive: domain=OS 91 HiAppEvent eventName=RESOURCE_OVERLIMIT 92 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}} 93 ```