性能打點(diǎn)

本模塊提供了追蹤進(jìn)程軌跡，度量程序執(zhí)行性能的打點(diǎn)能力。本模塊打點(diǎn)的數(shù)據(jù)供hiTraceMeter工具分析使用。

說(shuō)明： 本模塊首批接口從API version 8開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。 開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導(dǎo)入模塊

import hiTraceMeter from '@ohos.hiTraceMeter';

hiTraceMeter.startTrace

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

標(biāo)記一個(gè)預(yù)追蹤耗時(shí)任務(wù)的開(kāi)始，expectedTime是可選參數(shù)，標(biāo)識(shí)該任務(wù)的期望耗時(shí)。

如果有多個(gè)相同name的任務(wù)需要追蹤或者對(duì)同一個(gè)任務(wù)要追蹤多次，并且任務(wù)同時(shí)被執(zhí)行，則每次調(diào)用startTrace的taskId不相同。

如果具有相同name的任務(wù)是串行執(zhí)行的，則taskId可以相同。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiTrace

參數(shù)：

示例：

hiTraceMeter.startTrace("myTestFunc", 1);

hiTraceMeter.finishTrace

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

標(biāo)記一個(gè)預(yù)追蹤耗時(shí)任務(wù)的結(jié)束。

finishTrace的name和taskId必須與流程開(kāi)始的[startTrace]對(duì)應(yīng)參數(shù)值一致。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiTrace

參數(shù)：

示例：

hiTraceMeter.finishTrace("myTestFunc", 1);

//追蹤并行執(zhí)行的同名任務(wù)
hiTraceMeter.startTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
hiTraceMeter.startTrace("myTestFunc", 2);  //第二個(gè)追蹤的任務(wù)開(kāi)始，同時(shí)第一個(gè)追蹤的同名任務(wù)還沒(méi)結(jié)束，出現(xiàn)了并行執(zhí)行，對(duì)應(yīng)接口的taskId需要不同。
//業(yè)務(wù)流程...... 
hiTraceMeter.finishTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
hiTraceMeter.finishTrace("myTestFunc", 2);

//追蹤串行執(zhí)行的同名任務(wù)
hiTraceMeter.startTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
hiTraceMeter.finishTrace("myTestFunc", 1);  //第一個(gè)追蹤的任務(wù)結(jié)束
//業(yè)務(wù)流程...... 
hiTraceMeter.startTrace("myTestFunc", 1);   //第二個(gè)追蹤的同名任務(wù)開(kāi)始，同名的待追蹤任務(wù)串行執(zhí)行。
//業(yè)務(wù)流程...... 
hiTraceMeter.finishTrace("myTestFunc", 1);

hiTraceMeter.traceByValue

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

用來(lái)標(biāo)記一個(gè)預(yù)追蹤的數(shù)值變量，該變量的數(shù)值會(huì)不斷變化。

系統(tǒng)能力： SystemCapability.HiviewDFX.HiTrace

參數(shù)：

示例：

let traceCount = 3;
hiTraceMeter.traceByValue("myTestCount", traceCount);
traceCount = 4;
hiTraceMeter.traceByValue("myTestCount", traceCount);
//業(yè)務(wù)流程......

審核編輯 黃宇