本模块提供了追踪进程轨迹的能力,用于应用性能分析场景。开发者可以通过性能打点来追踪关键代码段的执行时间,定位性能瓶颈,优化应用性能。适用于应用启动耗时分析、业务流程性能监控、帧率分析等场景。
startTrace(name: string, taskId: number, expectedTime?: number): void
标记一个时间片跟踪任务的开始。
系统能力: SystemCapability.HiviewDFX.HiTrace
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 时间片跟踪任务名称。 |
| taskId | number | 是 | 时间片跟踪任务id。 |
| expectedTime | number | 否 | 期望的耗时时间(单位:ms)。设置该值后,系统会在实际执行时间超过期望值时产生性能警告。可选,默认为空表示不产生警告。 |
示例:
bytrace.startTrace("myTestFunc", 1);
bytrace.startTrace("myTestFunc", 1, 5); // 从startTrace到finishTrace流程的期望耗时为5ms finishTrace(name: string, taskId: number): void
标记一个时间片跟踪事件的结束。
系统能力:SystemCapability.HiviewDFX.HiTrace
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 时间片跟踪任务名称,必须与startTrace调用时的name参数值一致。 |
| taskId | number | 是 | 时间片跟踪任务id,必须与startTrace调用时的taskId参数值一致。 |
示例:
bytrace.finishTrace("myTestFunc", 1); // 跟踪并行执行的同名任务
bytrace.startTrace("myTestFunc", 1);
// 业务流程......
bytrace.startTrace("myTestFunc", 2); // 第二个跟踪任务开始,同时第一个同名跟踪任务还没结束,出现了并行执行,对应接口的taskId需要不同
// 业务流程......
bytrace.finishTrace("myTestFunc", 1);
// 业务流程......
bytrace.finishTrace("myTestFunc", 2); // 跟踪串行执行的同名任务
bytrace.startTrace("myTestFunc", 1);
// 业务流程......
bytrace.finishTrace("myTestFunc", 1); // 第一个跟踪任务结束
// 业务流程......
bytrace.startTrace("myTestFunc", 1); // 第二个跟踪任务开始,同名跟踪任务串行执行
// 业务流程......
bytrace.finishTrace("myTestFunc", 1); traceByValue(name: string, count: number): void
标记预追踪耗时任务的数值变量,该变量的数值会不断变化。traceByValue可独立使用,用于记录某个数值变量的变化轨迹。
系统能力:SystemCapability.HiviewDFX.HiTrace
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 数值变量的名称。 |
| count | number | 是 | 数值变量的值。 |
示例:
let traceCount = 3;
bytrace.traceByValue("myTestCount", traceCount);
traceCount = 4;
bytrace.traceByValue("myTestCount", traceCount);
// 业务流程......