js-apis-hiviewdfx-hiappevent.md 17.4 KB
Newer Older
1
# @ohos.hiviewdfx.hiAppEvent (应用事件打点)
L
lyj_love_code 已提交
2 3 4

本模块提供了应用事件打点能力,包括应用事件落盘、应用事件订阅、应用事件清理、打点功能配置等功能。

5 6
> **说明:**
>
L
lyj_love_code 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```js
import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent';
```

## hiAppEvent.write

write(info: [AppEventInfo](#appeventinfo), callback: AsyncCallback<void>): void

应用事件打点方法,将事件写入到当天的事件文件中,可接收[AppEventInfo](#appeventinfo)类型的事件对象,使用callback方式作为异步回调。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**参数:**

| 参数名   | 类型                           | 必填 | 说明           |
| -------- | ------------------------------ | ---- | -------------- |
| info     | [AppEventInfo](#appeventinfo) | 是   | 应用事件对象。 |
29
| callback | AsyncCallback<void>      | 是   | 打点回调函数。 |
L
lyj_love_code 已提交
30 31 32

**错误码:**

33
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

| 错误码ID | 错误信息                                      |
| -------- | --------------------------------------------- |
| 11100001 | Function is disabled.                         |
| 11101001 | Invalid event domain.                         |
| 11101002 | Invalid event name.                           |
| 11101003 | Invalid number of event parameters.           |
| 11101004 | Invalid string length of the event parameter. |
| 11101005 | Invalid event parameter name.                 |
| 11101006 | Invalid array length of the event parameter.  |

**示例:**

```js
hiAppEvent.write({
    domain: "test_domain",
    name: "test_event",
    eventType: hiAppEvent.EventType.FAULT,
    params: {
        int_data: 100,
        str_data: "strValue"
    }
}, (err) => {
    if (err) {
        console.error(`code: ${err.code}, message: ${err.message}`);
        return;
    }
    console.log(`success to write event`);
});
```

## hiAppEvent.write

write(info: [AppEventInfo](#appeventinfo)): Promise<void>

应用事件打点方法,将事件写入到当天的事件文件中,可接收[AppEventInfo](#appeventinfo)类型的事件对象,使用Promise方式作为异步回调。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**参数:**

| 参数名 | 类型                           | 必填 | 说明           |
| ------ | ------------------------------ | ---- | -------------- |
| info   | [AppEventInfo](#appeventinfo) | 是   | 应用事件对象。 |

**返回值:**

81 82 83
| 类型                | 说明          |
| ------------------- | ------------- |
| Promise<void> | Promise对象。 |
L
lyj_love_code 已提交
84 85 86

**错误码:**

87
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

| 错误码ID | 错误信息                                      |
| -------- | --------------------------------------------- |
| 11100001 | Function is disabled.                         |
| 11101001 | Invalid event domain.                         |
| 11101002 | Invalid event name.                           |
| 11101003 | Invalid number of event parameters.           |
| 11101004 | Invalid string length of the event parameter. |
| 11101005 | Invalid event parameter name.                 |
| 11101006 | Invalid array length of the event parameter.  |

**示例:**

```js
hiAppEvent.write({
    domain: "test_domain",
    name: "test_event",
    eventType: hiAppEvent.EventType.FAULT,
    params: {
        int_data: 100,
        str_data: "strValue"
    }
}).then(() => {
    console.log(`success to write event`);
}).catch((err) => {
    console.error(`code: ${err.code}, message: ${err.message}`);
});
```

## AppEventInfo

此接口提供了应用事件信息的参数选项。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

123 124 125
| 名称      | 类型                    | 必填 | 说明                                                         |
| --------- | ----------------------- | ---- | ------------------------------------------------------------ |
| domain    | string                  | 是   | 事件领域。事件领域名称支持数字、小写字母、下划线字符,需要以小写字母开头且不能以下划线结尾,长度非空且不超过32个字符。 |
126
| name      | string                  | 是   | 事件名称。事件名称支持数字字符、字母字符、下划线字符,需要以字母字符或$字符开头且不能以下划线字符结尾,长度非空且不超过48个字符。 |
127
| eventType | [EventType](#eventtype) | 是   | 事件类型。                                                   |
128
| params    | object                  | 是   | 事件参数对象,每个事件参数包括参数名和参数值,其规格定义如下:<br>- 参数名为string类型,只支持数字字符、字母字符、下划线字符,需要以字母字符或$字符开头且不能以下划线字符结尾,长度非空且不超过16个字符。<br>- 参数值支持string、number、boolean、数组类型,string类型参数长度需在8*1024个字符以内,超出会做丢弃处理;number类型参数取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内,超出可能会产生不确定值;数组类型参数中的元素类型只能全为string、number、boolean中的一种,且元素个数需在100以内,超出会做丢弃处理。<br>- 参数个数需在32个以内,超出的参数会做丢弃处理。 |
L
lyj_love_code 已提交
129 130 131

## hiAppEvent.configure

132
configure(config: [ConfigOption](configoption)): void
L
lyj_love_code 已提交
133

134
应用事件打点配置方法,可用于配置打点开关、目录存储配额大小等功能。
L
lyj_love_code 已提交
135 136 137 138 139 140 141 142 143 144 145

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**参数:**

| 参数名 | 类型                          | 必填 | 说明                     |
| ------ | ----------------------------- | ---- | ------------------------ |
| config | [ConfigOption](#configoption) | 是   | 应用事件打点配置项对象。 |

**错误码:**

146
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
147 148 149 150 151 152 153 154

| 错误码ID | 错误信息                         |
| -------- | -------------------------------- |
| 11103001 | Invalid max storage quota value. |

**示例:**

```js
155
// 配置打点开关为关闭状态
L
lyj_love_code 已提交
156 157 158 159
hiAppEvent.configure({
    disable: true
});

160
// 配置文件目录存储配额为100M
L
lyj_love_code 已提交
161 162 163 164 165 166 167
hiAppEvent.configure({
    maxStorage: '100M'
});
```

## ConfigOption

168
此接口提供了对应用事件打点功能的配置选项。
L
lyj_love_code 已提交
169 170 171

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

172
| 名称       | 类型    | 必填 | 说明                                                         |
L
lyj_love_code 已提交
173
| ---------- | ------- | ---- | ------------------------------------------------------------ |
174 175
| disable    | boolean | 否   | 打点功能开关,默认值为false。true:关闭打点功能,false:不关闭打点功能。 |
| maxStorage | string  | 否   | 打点数据存放目录的配额大小,默认值为“10M”。<br>在目录大小超出配额后,下次打点会触发对目录的清理操作:按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出配额时结束。 |
L
lyj_love_code 已提交
176 177 178 179 180

## hiAppEvent.addWatcher

addWatcher(watcher: [Watcher](#watcher)): [AppEventPackageHolder](#appeventpackageholder)

181
添加应用事件观察者方法,可用于订阅应用事件。
L
lyj_love_code 已提交
182 183 184 185 186 187 188

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**参数:**

| 参数名  | 类型                 | 必填 | 说明             |
| ------- | -------------------- | ---- | ---------------- |
189
| watcher | [Watcher](#watcher) | 是   | 应用事件观察者。 |
L
lyj_love_code 已提交
190 191 192 193 194 195 196 197 198

**返回值:**

| 类型                                             | 说明                                 |
| ------------------------------------------------ | ------------------------------------ |
| [AppEventPackageHolder](#appeventpackageholder) | 订阅数据持有者,订阅失败时返回null。 |

**错误码:**

199
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
200 201 202 203 204 205 206 207 208 209 210 211

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 11102001 | Invalid watcher name.           |
| 11102002 | Invalid filtering event domain. |
| 11102003 | Invalid row value.              |
| 11102004 | Invalid size value.             |
| 11102005 | Invalid timeout value.          |

**示例:**

```js
212
// 1. 如果观察者传入了回调的相关参数,则可以选择在自动触发的回调函数中对订阅事件进行处理
L
lyj_love_code 已提交
213 214 215 216
hiAppEvent.addWatcher({
    name: "watcher1",
    appEventFilters: [
        {
217
            domain: "test_domain",
L
lyj_love_code 已提交
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
            eventTypes: [hiAppEvent.EventType.FAULT, hiAppEvent.EventType.BEHAVIOR]
        }
    ],
    triggerCondition: {
        row: 10,
        size: 1000,
        timeOut: 1
    },
    onTrigger: function (curRow, curSize, holder) {
        if (holder == null) {
            console.error("holder is null");
            return;
        }
        let eventPkg = null;
        while ((eventPkg = holder.takeNext()) != null) {
            console.info(`eventPkg.packageId=${eventPkg.packageId}`);
            console.info(`eventPkg.row=${eventPkg.row}`);
            console.info(`eventPkg.size=${eventPkg.size}`);
            for (const eventInfo of eventPkg.data) {
                console.info(`eventPkg.data=${eventInfo}`);
            }
        }
    }
});

243
// 2. 如果观察者未传入回调的相关参数,则可以选择使用返回的holder对象手动去处理订阅事件
L
lyj_love_code 已提交
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
let holder = hiAppEvent.addWatcher({
    name: "watcher2",
});
if (holder != null) {
    let eventPkg = null;
    while ((eventPkg = holder.takeNext()) != null) {
        console.info(`eventPkg.packageId=${eventPkg.packageId}`);
        console.info(`eventPkg.row=${eventPkg.row}`);
        console.info(`eventPkg.size=${eventPkg.size}`);
        for (const eventInfo of eventPkg.data) {
            console.info(`eventPkg.data=${eventInfo}`);
        }
    }
}
```

## hiAppEvent.removeWatcher

removeWatcher(watcher: [Watcher](#watcher)): void

264
移除应用事件观察者方法,可用于取消订阅应用事件。
L
lyj_love_code 已提交
265 266 267 268 269 270 271

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**参数:**

| 参数名  | 类型                 | 必填 | 说明             |
| ------- | -------------------- | ---- | ---------------- |
272
| watcher | [Watcher](#watcher) | 是   | 应用事件观察者。 |
L
lyj_love_code 已提交
273 274 275

**错误码:**

276
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
277 278 279 280 281 282 283 284

| 错误码ID | 错误信息              |
| -------- | --------------------- |
| 11102001 | Invalid watcher name. |

**示例:**

```js
285
// 1. 定义一个应用事件观察者
L
lyj_love_code 已提交
286 287 288 289
let watcher = {
    name: "watcher1",
}

290
// 2. 添加一个应用事件观察者来订阅事件
L
lyj_love_code 已提交
291 292
hiAppEvent.addWatcher(watcher);

293
// 3. 移除该应用事件观察者以取消订阅事件
L
lyj_love_code 已提交
294 295 296 297 298
hiAppEvent.removeWatcher(watcher);
```

## Watcher

299
此接口提供了应用事件观察者的参数选项。
L
lyj_love_code 已提交
300 301 302

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

303
| 名称             | 类型                                                         | 必填 | 说明                                                         |
304 305 306 307 308
| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| name             | string                                                       | 是   | 观察者名称,用于唯一标识观察者。                             |
| triggerCondition | [TriggerCondition](#triggercondition)                        | 否   | 订阅回调触发条件,需要与回调函数一同传入才会生效。           |
| appEventFilters  | [AppEventFilter](#appeventfilter)[]                          | 否   | 订阅过滤条件,在需要对订阅事件进行过滤时传入。               |
| onTrigger        | (curRow: number, curSize: number, holder: [AppEventPackageHolder](#appeventpackageholder)) => void | 否   | 订阅回调函数,需要与回调触发条件一同传入才会生效,函数入参说明如下:<br>curRow:在本次回调触发时的订阅事件总数量; <br>curSize:在本次回调触发时的订阅事件总大小,单位为byte;  <br/>holder:订阅数据持有者对象,可以通过其对订阅事件进行处理。 |
L
lyj_love_code 已提交
309 310 311

## TriggerCondition

312
此接口提供了回调触发条件的参数选项,只要满足任一条件就会触发订阅回调。
L
lyj_love_code 已提交
313 314 315

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

316 317 318 319 320
| 名称    | 类型   | 必填 | 说明                                   |
| ------- | ------ | ---- | -------------------------------------- |
| row     | number | 否   | 满足触发回调的事件总数量。             |
| size    | number | 否   | 满足触发回调的事件总大小,单位为byte。 |
| timeOut | number | 否   | 满足触发回调的超时时长,单位为30s。    |
L
lyj_love_code 已提交
321 322 323

## AppEventFilter

324
此接口提供了过滤应用事件的参数选项。
L
lyj_love_code 已提交
325 326 327

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

328
| 名称       | 类型                      | 必填 | 说明                     |
L
lyj_love_code 已提交
329 330 331 332 333 334 335 336 337 338 339 340
| ---------- | ------------------------- | ---- | ------------------------ |
| domain     | string                    | 是   | 需要订阅的事件领域。     |
| eventTypes | [EventType](#eventtype)[] | 否   | 需要订阅的事件类型集合。 |

## AppEventPackageHolder

订阅数据持有者类,用于对订阅事件进行处理。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

### constructor

341
constructor(watcherName: string)
L
lyj_love_code 已提交
342

343
类构造函数,在添加应用事件观察者时,会由系统自动调用来创建一个该观察者对应的订阅数据持有者对象,并返回给开发者。
L
lyj_love_code 已提交
344 345 346

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

347 348 349 350 351 352
**参数:**

| 参数名 | 类型              | 必填 | 说明                     |
| ------ | ----------------- | ---- | ------------------------ |
| watcherName | string | 是   | 观察者名称。 |

L
lyj_love_code 已提交
353 354 355 356 357 358 359 360 361 362 363 364
**示例:**

```js
let holder = hiAppEvent.addWatcher({
    name: "watcher",
});
```

### setSize

setSize(size: number): void

365
设置每次取出的应用事件包的数据大小阈值。
L
lyj_love_code 已提交
366 367 368

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

369 370 371 372 373 374
**参数:**

| 参数名 | 类型   | 必填 | 说明                                         |
| ------ | ------ | ---- | -------------------------------------------- |
| size   | number | 是   | 数据大小阈值,单位为byte,默认值为512*1024。 |

L
lyj_love_code 已提交
375 376
**错误码:**

377
以下错误码的详细介绍请参见[应用事件打点错误码](../errorcodes/errorcode-hiappevent.md)
L
lyj_love_code 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414

| 错误码ID | 错误信息            |
| -------- | ------------------- |
| 11104001 | Invalid size value. |

**示例:**

```js
let holder = hiAppEvent.addWatcher({
    name: "watcher",
});
holder.setSize(1000);
```

### takeNext

takeNext(): [AppEventPackage](#appeventpackage)

根据设置的数据大小阈值来取出订阅事件数据,当订阅事件数据全部被取出时返回null作为标识。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**示例:**

```js
let holder = hiAppEvent.addWatcher({
    name: "watcher",
});
let eventPkg = holder.takeNext();
```

## AppEventPackage

此接口提供了订阅返回的应用事件包的参数定义。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

415 416 417 418 419 420
| 名称      | 类型     | 必填 | 说明                           |
| --------- | -------- | ---- | ------------------------------ |
| packageId | number   | 是   | 事件包ID,从0开始自动递增。    |
| row       | number   | 是   | 事件包的事件数量。             |
| size      | number   | 是   | 事件包的事件大小,单位为byte。 |
| data      | string[] | 是   | 事件包的事件信息。             |
L
lyj_love_code 已提交
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442

## hiAppEvent.clearData

clearData(): void

应用事件打点数据清理方法,将应用存储在本地的打点数据进行清除。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

**示例:**

```js
hiAppEvent.clearData();
```


## EventType

事件类型枚举。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

443 444 445 446 447 448
| 名称      | 值   | 说明           |
| --------- | ---- | -------------- |
| FAULT     | 1    | 故障类型事件。 |
| STATISTIC | 2    | 统计类型事件。 |
| SECURITY  | 3    | 安全类型事件。 |
| BEHAVIOR  | 4    | 行为类型事件。 |
L
lyj_love_code 已提交
449 450


451
## event
L
lyj_love_code 已提交
452 453 454 455 456

此接口提供了所有预定义事件的事件名称常量。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

457 458 459 460 461
| 名称                      | 类型   | 说明                 |
| ------------------------- | ------ | -------------------- |
| USER_LOGIN                | string | 用户登录事件。       |
| USER_LOGOUT               | string | 用户登出事件。       |
| DISTRIBUTED_SERVICE_START | string | 分布式服务启动事件。 |
L
lyj_love_code 已提交
462 463


464
## param
L
lyj_love_code 已提交
465 466 467 468 469

此接口提供了所有预定义参数的参数名称常量。

**系统能力:** SystemCapability.HiviewDFX.HiAppEvent

470 471 472 473 474
| 名称                            | 类型   | 说明               |
| ------------------------------- | ------ | ------------------ |
| USER_ID                         | string | 用户自定义ID。     |
| DISTRIBUTED_SERVICE_NAME        | string | 分布式服务名称。   |
| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 分布式服务实例ID。 |