diff --git a/zh-cn/application-dev/dfx/hitracemeter-guidelines.md b/zh-cn/application-dev/dfx/hitracemeter-guidelines.md index fa287bd515c28516dbb8715c4259fcfed83bd48d..63765e10ca1b7e79a4db231e93b6fd39e7a9b192 100644 --- a/zh-cn/application-dev/dfx/hitracemeter-guidelines.md +++ b/zh-cn/application-dev/dfx/hitracemeter-guidelines.md @@ -2,7 +2,7 @@ ## 场景介绍 -HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口，能够有效追踪进程轨迹、查看系统性能。 +HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口，能够有效跟踪进程轨迹、查看系统性能。 ## 接口说明 @@ -12,15 +12,15 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自 | 接口名 | 返回值 | 描述 | | ---------------------------------------------------------------------------- | --------- | ------------ | -| hiTraceMeter.startTrace(name: string, taskId: number, expectedTime?: number) | void | 标记一个预追踪耗时任务的开始。如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次，并且任务同时被执行，则每次调用startTrace的taskId不相同。如果具有相同name的任务是串行执行的，则taskId可以相同。 | +| hiTraceMeter.startTrace(name: string, taskId: number, expectedTime?: number) | void | 标记一个预跟踪耗时任务的开始。如果有多个相同name的任务需要跟踪或者对同一个任务要跟踪多次，并且任务同时被执行，则每次调用startTrace的taskId不相同。如果具有相同name的任务是串行执行的，则taskId可以相同。 | | hiTraceMeter.finishTrace(name: string, taskId: number) | void | name和taskId必须与流程开始的hiTraceMeter.startTrace对应参数值保持一致。 | -| hiTraceMeter.traceByValue(name: string, value: number) | void | 用来标记一个预追踪的数值变量，该变量的数值会不断变化。| +| hiTraceMeter.traceByValue(name: string, value: number) | void | 用来标记一个预跟踪的数值变量，该变量的数值会不断变化。| ## 开发步骤 在应用启动执行页面加载后，开始分布式跟踪，完成业务之后，停止分布式跟踪。 -1. 新建一个JS应用工程，在“Project”窗口点击“entry > src > main > js > default > pages > index”，打开工程中的“index.js”文件，在页面执行加载后，在自己的业务中调用hiTraceMeter的接口，进行性能打点追踪，示例代码如下： +1. 新建一个JS应用工程，在“Project”窗口点击“entry > src > main > js > default > pages > index”，打开工程中的“index.js”文件，在页面执行加载后，在自己的业务中调用hiTraceMeter的接口，进行性能打点跟踪，示例代码如下： ```js import hiTraceMeter from '@ohos.hiTraceMeter' @@ -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; diff --git a/zh-cn/application-dev/dfx/hitracemeter-overview.md b/zh-cn/application-dev/dfx/hitracemeter-overview.md index 8c7b503c7705153663ed598923bb510fc5bb6fdb..3c31db921da5db0d9a9a29514ec606dfa2c88bb5 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提供的命令行工具采集跟踪数据。 ## 基本概念 diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md b/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md index 4664e089d2d341df4d5303f7228f5dc862dd565b..489c14d8d3e154e39cf4a9802332d0df41c71047 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md @@ -1,6 +1,6 @@ # 性能打点 -本模块提供了追踪进程轨迹，度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。 +本模块提供了跟踪进程轨迹，度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -17,9 +17,9 @@ import hiTraceMeter from '@ohos.hiTraceMeter'; startTrace(name: string, taskId: number): void -标记一个预追踪耗时任务的开始。 +标记一个预跟踪耗时任务的开始。 -如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次，并且任务同时被执行，则每次调用startTrace的taskId不相同。 +如果有多个相同name的任务需要跟踪或者对同一个任务要跟踪多次，并且任务同时被执行，则每次调用startTrace的taskId不相同。 如果具有相同name的任务是串行执行的，则taskId可以相同。具体示例可参考[hiTraceMeter.finishTrace](#hitracemeterfinishtrace)中的示例。 @@ -29,7 +29,7 @@ startTrace(name: string, taskId: number): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| name | string | 是 | 要追踪的任务名称 | +| name | string | 是 | 要跟踪的任务名称 | | taskId | number | 是 | 任务id | **示例：** @@ -43,7 +43,7 @@ hiTraceMeter.startTrace("myTestFunc", 1); finishTrace(name: string, taskId: number): void -标记一个预追踪耗时任务的结束。 +标记一个预跟踪耗时任务的结束。 finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemeterstarttrace)对应参数值一致。 @@ -53,7 +53,7 @@ finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemetersta | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| name | string | 是 | 要追踪的任务名称 | +| name | string | 是 | 要跟踪的任务名称 | | taskId | number | 是 | 任务id。 | **示例：** @@ -63,24 +63,24 @@ hiTraceMeter.finishTrace("myTestFunc", 1); ``` ```js -//追踪并行执行的同名任务 +// 跟踪并行执行的同名任务 hiTraceMeter.startTrace("myTestFunc", 1); -//业务流程...... -hiTraceMeter.startTrace("myTestFunc", 2); //第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 -//业务流程...... +// 业务流程...... +hiTraceMeter.startTrace("myTestFunc", 2); // 第二个跟踪的任务开始，同时第一个跟踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 +// 业务流程...... hiTraceMeter.finishTrace("myTestFunc", 1); -//业务流程...... +// 业务流程...... hiTraceMeter.finishTrace("myTestFunc", 2); ``` ```js -//追踪串行执行的同名任务 +// 跟踪串行执行的同名任务 hiTraceMeter.startTrace("myTestFunc", 1); -//业务流程...... -hiTraceMeter.finishTrace("myTestFunc", 1); //第一个追踪的任务结束 -//业务流程...... -hiTraceMeter.startTrace("myTestFunc", 1); //第二个追踪的同名任务开始，同名的待追踪任务串行执行。 -//业务流程...... +// 业务流程...... +hiTraceMeter.finishTrace("myTestFunc", 1); // 第一个跟踪的任务结束 +// 业务流程...... +hiTraceMeter.startTrace("myTestFunc", 1); // 第二个跟踪的同名任务开始，同名的待跟踪任务串行执行。 +// 业务流程...... hiTraceMeter.finishTrace("myTestFunc", 1); ``` @@ -89,7 +89,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1); traceByValue(name: string, count: number): void -用来标记一个预追踪的数值变量，该变量的数值会不断变化。 +用来标记一个预跟踪的数值变量，该变量的数值会不断变化。 **系统能力：** SystemCapability.HiviewDFX.HiTrace @@ -97,7 +97,7 @@ traceByValue(name: string, count: number): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| name | string | 是 | 要追踪的数值变量名称 | +| name | string | 是 | 要跟踪的数值变量名称 | | count | number | 是 | 变量的值 | **示例：**