diff --git a/zh-cn/application-dev/dfx/hiappevent-guidelines.md b/zh-cn/application-dev/dfx/hiappevent-guidelines.md index cd5a98b3f5c220ac36cf0a0fa00eea59e3df4b2b..e38e964549bbf0372ae41978fd702ae222d283c9 100644 --- a/zh-cn/application-dev/dfx/hiappevent-guidelines.md +++ b/zh-cn/application-dev/dfx/hiappevent-guidelines.md @@ -17,7 +17,8 @@ | write(string eventName, EventType type, object keyValues, AsyncCallback\ callback): void | void | 应用事件异步打点方法，使用callback方式作为异步回调。 | | write(string eventName, EventType type, object keyValues): Promise\ | Promise\ | 应用事件异步打点方法，使用promise方式作为异步回调。 | -当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](hiappevent-overview.md#事件校验结果码)。 +当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](#事件校验结果码)。 + **打点配置接口功能介绍：** @@ -25,6 +26,24 @@ | ------------------------------ | ------- | ------------------------------------------------------------ | | configure(ConfigOption config) | boolean | 应用事件打点配置方法，可以对打点功能进行自定义配置。返回true表示配置成功，false表示配置失败。 | + +### 事件校验结果码 + +| 错误码 | 原因 | 校验规则 | 处理结果 | +| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| 0 | 无 | 事件校验成功 | 事件正常打点。 | +| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。 | 忽略该事件，不执行打点。 | +| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。
事件类型参数必须为number类型。
keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 | +| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 | +| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 | +| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。
非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 | +| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 | +| 3 | 无效的value参数类型 | value参数只支持以下类型：
boolean、number、string、Array[基本类型]。
| 忽略该键值对参数后，继续执行打点。 | +| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 | +| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 | +| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 | +| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。
List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 | + ## 开发步骤 在应用启动执行页面加载后，执行一个应用事件打点，用于记录应用的初始页面加载事件。 diff --git a/zh-cn/application-dev/dfx/hiappevent-overview.md b/zh-cn/application-dev/dfx/hiappevent-overview.md index e4965580756d232ec0edf3cc48411b90c890c2a2..d2b993f0a1384e1469572c28c7e133aa80f1cafc 100644 --- a/zh-cn/application-dev/dfx/hiappevent-overview.md +++ b/zh-cn/application-dev/dfx/hiappevent-overview.md @@ -8,19 +8,3 @@ HiAppEvent模块支持应用事件业务的开发，提供应用事件相关的 **打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。 -## 事件校验结果码 - -| 错误码 | 原因 | 校验规则 | 处理结果 | -| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| 0 | 无 | 事件校验成功 | 事件正常打点。 | -| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。 | 忽略该事件，不执行打点。 | -| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。
事件类型参数必须为number类型。
keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 | -| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 | -| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 | -| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。
非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 | -| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 | -| 3 | 无效的value参数类型 | value参数只支持以下类型：
boolean、number、string、Array[基本类型]。
| 忽略该键值对参数后，继续执行打点。 | -| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 | -| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 | -| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 | -| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。
List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 | \ No newline at end of file diff --git a/zh-cn/application-dev/dfx/hitracemeter-overview.md b/zh-cn/application-dev/dfx/hitracemeter-overview.md index a6144101ad710c69bf7a8833580c2a4142438df0..8c7b503c7705153663ed598923bb510fc5bb6fdb 100644 --- a/zh-cn/application-dev/dfx/hitracemeter-overview.md +++ b/zh-cn/application-dev/dfx/hitracemeter-overview.md @@ -6,7 +6,7 @@ hiTraceMeter是开发者用于追踪进程轨迹，度量程序执行性能的 - **hiTraceMeter Tag** - 跟踪数据使用类别分类，称作hiTraceMeter Tag或hiTraceMeter Category，一般每个软件子系统对应一个Tag，该Tag在打点API中以类别TAg参数传入。hiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。 + 跟踪数据使用类别分类，称作hiTraceMeter Tag或hiTraceMeter Category，一般每个软件子系统对应一个Tag，该Tag在打点API中以类别Tag参数传入。hiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。 ## 运作机制