1# @ohos.hiTraceMeter (性能打点) 2 3本模块提供了跟踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。 4 5> **说明:** 6> 7> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 8 9 10## 导入模块 11 12```js 13import hiTraceMeter from '@ohos.hiTraceMeter'; 14``` 15 16 17## hiTraceMeter.startTrace 18 19startTrace(name: string, taskId: number): void 20 21标记一个预跟踪耗时任务的开始。 22 23如果有多个相同name的任务需要跟踪或者对同一个任务要跟踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。 24 25如果具有相同name的任务是串行执行的,则taskId可以相同。具体示例可参考[hiTraceMeter.finishTrace](#hitracemeterfinishtrace)中的示例。 26 27**系统能力:** SystemCapability.HiviewDFX.HiTrace 28 29**参数:** 30 31| 参数名 | 类型 | 必填 | 说明 | 32| -------- | -------- | -------- | -------- | 33| name | string | 是 | 要跟踪的任务名称 | 34| taskId | number | 是 | 任务id | 35 36**示例:** 37 38```js 39hiTraceMeter.startTrace("myTestFunc", 1); 40``` 41 42 43## hiTraceMeter.finishTrace 44 45finishTrace(name: string, taskId: number): void 46 47标记一个预跟踪耗时任务的结束。 48 49finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemeterstarttrace)对应参数值一致。 50 51**系统能力:** SystemCapability.HiviewDFX.HiTrace 52 53**参数:** 54 55| 参数名 | 类型 | 必填 | 说明 | 56| -------- | -------- | -------- | -------- | 57| name | string | 是 | 要跟踪的任务名称 | 58| taskId | number | 是 | 任务id。 | 59 60**示例:** 61 62```js 63hiTraceMeter.finishTrace("myTestFunc", 1); 64``` 65 66```js 67// 跟踪并行执行的同名任务 68hiTraceMeter.startTrace("myTestFunc", 1); 69// 业务流程...... 70hiTraceMeter.startTrace("myTestFunc", 2); // 第二个跟踪的任务开始,同时第一个跟踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。 71// 业务流程...... 72hiTraceMeter.finishTrace("myTestFunc", 1); 73// 业务流程...... 74hiTraceMeter.finishTrace("myTestFunc", 2); 75``` 76 77```js 78// 跟踪串行执行的同名任务 79hiTraceMeter.startTrace("myTestFunc", 1); 80// 业务流程...... 81hiTraceMeter.finishTrace("myTestFunc", 1); // 第一个跟踪的任务结束 82// 业务流程...... 83hiTraceMeter.startTrace("myTestFunc", 1); // 第二个跟踪的同名任务开始,同名的待跟踪任务串行执行。 84// 业务流程...... 85hiTraceMeter.finishTrace("myTestFunc", 1); 86``` 87 88 89## hiTraceMeter.traceByValue 90 91traceByValue(name: string, count: number): void 92 93用来标记一个预跟踪的数值变量,该变量的数值会不断变化。 94 95**系统能力:** SystemCapability.HiviewDFX.HiTrace 96 97**参数:** 98 99| 参数名 | 类型 | 必填 | 说明 | 100| -------- | -------- | -------- | -------- | 101| name | string | 是 | 要跟踪的数值变量名称 | 102| count | number | 是 | 变量的值 | 103 104**示例:** 105```js 106let traceCount = 3; 107hiTraceMeter.traceByValue("myTestCount", traceCount); 108traceCount = 4; 109hiTraceMeter.traceByValue("myTestCount", traceCount); 110//业务流程...... 111``` 112