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