diff --git a/zh-cn/application-dev/dfx/hiappevent-guidelines.md b/zh-cn/application-dev/dfx/hiappevent-guidelines.md index e2d75afbbdee3e8f949e87ebfb7a7375a3e12bb5..f3f71ee2bd4874f970ad8d993f71b848fdb68694 100644 --- a/zh-cn/application-dev/dfx/hiappevent-guidelines.md +++ b/zh-cn/application-dev/dfx/hiappevent-guidelines.md @@ -2,24 +2,24 @@ ## 场景介绍 -应用事件打点的主要工作是在应用运行过程中，帮助应用记录在运行过程中发生的各种信息。 +应用事件打点的主要用于帮助应用记录在运行过程中发生的各种信息。 ## 接口说明 应用事件JS打点接口由hiAppEvent模块提供。 -以下仅提供简单的接口介绍，API接口的具体使用说明（参数使用限制、具体取值范围等），请参考[应用事件打点API文档](../reference/apis/js-apis-hiappevent.md)。 +以下仅提供简单的API接口介绍，具体使用说明（参数使用限制、具体取值范围等），请参考[应用事件打点API参考](../reference/apis/js-apis-hiappevent.md)。 -**打点接口功能介绍：** +**表1** 打点接口功能介绍 | 接口名 | 返回值 | 描述 | | ------------------------------------------------------------ | -------------- | ---------------------------------------------------- | | write(string eventName, EventType type, object keyValues, AsyncCallback\ callback): void | void | 应用事件异步打点方法，使用callback方式作为异步回调。 | -| write(string eventName, EventType type, object keyValues): Promise\ | Promise\ | 应用事件异步打点方法，使用promise方式作为异步回调。 | +| write(string eventName, EventType type, object keyValues): Promise\ | Promise\ | 应用事件异步打点方法，使用Promise方式作为异步回调。 | 当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](#事件校验结果码)。 -**打点配置接口功能介绍：** +**表2** 打点配置接口功能介绍 | 接口名 | 返回值 | 描述 | | ------------------------------ | ------- | ------------------------------------------------------------ | @@ -27,18 +27,18 @@ ### 事件校验结果码 -| 错误码 | 原因 | 校验规则 | 处理结果 | -| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| 0 | 无 | 事件校验成功 | 事件正常打点。 | +| 错误码 | 原因 | 校验规则 | 处理结果 | +| ------ | --------------------------- | ------------------------------------------------------------ | ------------------------------------------- | +| 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对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 | +| 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内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 | @@ -88,7 +88,7 @@ } ``` -2. 运行项目，点击应用界面上的运行按钮。 +2. 点击应用界面上的运行按钮运行项目。 ## 相关实例 diff --git a/zh-cn/application-dev/dfx/hiappevent-overview.md b/zh-cn/application-dev/dfx/hiappevent-overview.md index 8dfe1d52999e3a9f55bf111ed3bcb9378197f27c..6c025e2db25234262a993a32b4c78e7f610c0d82 100644 --- a/zh-cn/application-dev/dfx/hiappevent-overview.md +++ b/zh-cn/application-dev/dfx/hiappevent-overview.md @@ -1,9 +1,12 @@ # 应用事件打点概述 -HiAppEvent提供了应用事件打点接口，为应用提供事件打点的功能，用于帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息，以支撑开发者分析应用的运行情况。 +HiAppEvent为应用提供事件打点的功能，通过提供应用事件打点接口帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息，以支撑开发者分析应用的运行情况。 + +HiAppEvent模块支持应用事件业务的开发，提供应用事件相关的功能，主要包括应用事件落盘、查询历史应用事件数据等功能。 ## 基本概念 -HiAppEvent模块支持应用事件业务的开发，提供应用事件相关的功能，主要包括应用事件落盘、查询历史应用事件数据等功能。 -**打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。 \ No newline at end of file +- **打点**： + + 记录由用户操作引起的变化，提供业务数据信息，以供产品开发、优化、运维分析。 \ No newline at end of file diff --git a/zh-cn/application-dev/dfx/hitracemeter-guidelines.md b/zh-cn/application-dev/dfx/hitracemeter-guidelines.md index fa287bd515c28516dbb8715c4259fcfed83bd48d..aaefd0400b6070416d1371ad8e04606bea4d9d00 100644 --- a/zh-cn/application-dev/dfx/hitracemeter-guidelines.md +++ b/zh-cn/application-dev/dfx/hitracemeter-guidelines.md @@ -2,13 +2,13 @@ ## 场景介绍 -HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口，能够有效追踪进程轨迹、查看系统性能。 +HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter提供的API接口，能够有效追踪进程轨迹、查看系统性能。 ## 接口说明 性能打点跟踪接口由hiTraceMeter模块提供，详细API请参考[性能打点跟踪API参考](../reference/apis/js-apis-hitracemeter.md)。 -**性能打点跟踪接口功能介绍：** +**表1** 性能打点跟踪接口功能介绍 | 接口名 | 返回值 | 描述 | | ---------------------------------------------------------------------------- | --------- | ------------ | @@ -32,31 +32,31 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自 onInit() { this.title = this.$t('strings.world'); - //从startTrace到finishTrace流程的耗时期望为5ms + // 从startTrace到finishTrace流程的耗时期望为5ms hiTraceMeter.startTrace("business", 1); hiTraceMeter.startTrace("business", 1, 5); - //追踪并行执行的同名任务 + // 追踪并行执行的同名任务 hiTraceMeter.startTrace("business", 1); - //业务流程 + // 业务流程 console.log(`business running`); - hiTraceMeter.startTrace("business", 2); //第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 - //业务流程 + hiTraceMeter.startTrace("business", 2); // 第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同 + // 业务流程 console.log(`business running`); hiTraceMeter.finishTrace("business", 1); - //业务流程 + // 业务流程 console.log(`business running`); hiTraceMeter.finishTrace("business", 2); - //追踪串行执行的同名任务 + // 追踪串行执行的同名任务 hiTraceMeter.startTrace("business", 1); - //业务流程 + // 业务流程 console.log(`business running`); - hiTraceMeter.finishTrace("business", 1); //第一个追踪的任务结束 - //业务流程 + hiTraceMeter.finishTrace("business", 1); // 第一个追踪的任务结束 + // 业务流程 console.log(`business running`); - hiTraceMeter.startTrace("business", 1); //第二个追踪的同名任务开始，同名的待追踪任务串行执行。 - //业务流程 + hiTraceMeter.startTrace("business", 1); // 第二个追踪的同名任务开始，同名的待追踪任务串行执行 + // 业务流程 console.log(`business running`); let traceCount = 3; @@ -68,6 +68,6 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自 } ``` -2. 运行项目，点击应用界面上的运行按钮，即可通过日志信息分析实际业务。 +2. 点击应用界面上的运行按钮运行项目，即可通过日志信息分析实际业务。 diff --git a/zh-cn/application-dev/dfx/hitracemeter-overview.md b/zh-cn/application-dev/dfx/hitracemeter-overview.md index 8c7b503c7705153663ed598923bb510fc5bb6fdb..50673c97ec36c9a3e0356dbf0ccdb6f733f8dc67 100644 --- a/zh-cn/application-dev/dfx/hitracemeter-overview.md +++ b/zh-cn/application-dev/dfx/hitracemeter-overview.md @@ -1,6 +1,6 @@ # 性能打点跟踪概述 -hiTraceMeter是开发者用于追踪进程轨迹，度量程序执行性能的一种工具，基于内核的ftrace机制，提供给用户态应用代码执行时长度量打点的能力。开发者通过使用hiTraceMeter API在程序中打点，并使用hiTraceMeter提供的命令行工具采集跟踪数据。 +hiTraceMeter是用于追踪进程轨迹，度量程序执行性能的一种工具，基于内核的ftrace机制，提供给用户态应用代码执行时长度量打点的能力。开发者通过使用hiTraceMeter API在程序中打点，并使用hiTraceMeter提供的命令行工具采集跟踪数据。 ## 基本概念 @@ -15,4 +15,4 @@ hiTraceMeter是开发者用于追踪进程轨迹，度量程序执行性能的 ## 约束与限制 -- 由于JS程序的异步IO特性，现在hiTraceMeter只提供了异步接口。 \ No newline at end of file +由于JS程序的异步IO特性，现在hiTraceMeter只提供了异步接口。 \ No newline at end of file