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