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