性能打点

About 6 min

性能打点

说明: 从 API Version 7 开始支持。

导入模块

import bytrace from '@ohos.bytrace';
1

权限

bytrace.startTrace

startTrace(name: string, taskId: number, expectedTime?: number): void

标记一个预追踪耗时任务的开始,expectedTime是可选参数,标识该任务的期望耗时。

  • 参数:

    参数名

    类型

    必填

    说明

    name

    string

    要追踪的任务名称

    taskId

    number

    任务id

    expectedTime

    number

    期望的耗时时间,单位:ms

    说明: 如果多个要追踪任务的name相同,taskId必须不一致。通过name和taskId来唯一标识一个任务。

  • 示例:

    bytrace.startTrace("myTestFunc", 1);
    bytrace.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms
    
    1
    2

bytrace.finishTrace

finishTrace(name: string, taskId: number): void

标记一个预追踪耗时任务的结束。

  • 参数:

    参数名

    类型

    必填

    说明

    name

    string

    要追踪的任务名称

    taskId

    number

    任务id

    说明: finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。

  • 示例:

    bytrace.finishTrace("myTestFunc", 1);
    
    1

bytrace.traceByValue

traceByValue(name: string, count: number): void

用来标记一个预追踪的数值变量,该变量的数值会不断变化。

  • 参数:

    参数名

    类型

    必填

    说明

    name

    string

    要追踪的数值变量名称

    count

    number

    变量的值

  • 示例:

    let traceCount = 3;
    bytrace.traceByValue("myTestCount", traceCount);
    ......
    traceCount = 5;
    bytrace.traceByValue("myTestCount", traceCount);
    
    1
    2
    3
    4
    5