1# 性能打点跟踪开发指导 2 3## 简介 4 5hiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口，能够有效跟踪进程轨迹、查看系统性能。 6 7## 基本概念 8 9- **hiTraceMeter Tag** 10 11 跟踪数据使用类别分类，称作hiTraceMeter Tag或hiTraceMeter Category，一般每个软件子系统对应一个Tag，该Tag在打点API中以类别Tag参数传入。hiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。 12 13## 实现原理 14 15- 应用程序通过hiTraceMeter函数接口进行打点，hiTraceMeter函数将跟踪数据通过内核sysfs文件接口输出到内核的ftrace数据缓冲区。 16- hiTraceMeter命令行工具读取内核ftrace缓冲区中的跟踪数据，将文本格式的跟踪数据保存到设备侧的文件中。 17 18## 约束与限制 19 20- 由于JS程序的异步IO特性，现在hiTraceMeter只提供了异步接口。 21 22## 接口说明 23 24性能打点跟踪接口由hiTraceMeter模块提供，详细API请参考[性能打点跟踪API参考](../reference/apis/js-apis-hitracemeter.md)。 25 26**性能打点跟踪接口功能介绍：** 27 28| 接口名 | 返回值 | 描述 | 29| ---------------------------------------------------------------------------- | --------- | ------------ | 30| hiTraceMeter.startTrace(name: string, taskId: number) | void | 标记一个预跟踪耗时任务的开始。taskId是trace中用来表示关联的ID,如果有多个name相同的任务是并行执行的，则每次调用startTrace的taskId不同。如果具有相同name的任务是串行执行的，则taskId可以相同。 | 31| hiTraceMeter.finishTrace(name: string, taskId: number) | void | name和taskId必须与流程开始的hiTraceMeter.startTrace对应参数值保持一致。 | 32| hiTraceMeter.traceByValue(name: string, value: number) | void | 用来标记一个预跟踪的数值变量，该变量的数值会不断变化。| 33 34## 开发步骤 35 36在应用启动执行页面加载后，开始分布式跟踪，完成业务之后，停止分布式跟踪。 37 381. 新建一个JS应用工程，在“Project”窗口点击“entry > src > main > js > default > pages > index”，打开工程中的“index.js”文件，在页面执行加载后，在自己的业务中调用hiTraceMeter的接口，进行性能打点跟踪，示例代码如下： 39 40 ```js 41 import hiTraceMeter from '@ohos.hiTraceMeter' 42 43 export default { 44 data: { 45 title: "" 46 }, 47 onInit() { 48 this.title = this.$t('strings.world'); 49 50 // 跟踪并行执行的同名任务 51 hiTraceMeter.startTrace("business", 1); 52 // 业务流程 53 console.log(`business running`); 54 hiTraceMeter.startTrace("business", 2); // 第二个跟踪任务开始，同时第一个跟踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 55 // 业务流程 56 console.log(`business running`); 57 hiTraceMeter.finishTrace("business", 1); 58 // 业务流程 59 console.log(`business running`); 60 hiTraceMeter.finishTrace("business", 2); 61 62 // 跟踪串行执行的同名任务 63 hiTraceMeter.startTrace("business", 1); 64 // 业务流程 65 console.log(`business running`); 66 hiTraceMeter.finishTrace("business", 1); // 第一个跟踪的任务结束 67 // 业务流程 68 console.log(`business running`); 69 hiTraceMeter.startTrace("business", 1); // 第二个跟踪的同名任务开始，同名的待跟踪任务串行执行。 70 // 业务流程 71 console.log(`business running`); 72 73 let traceCount = 3; 74 hiTraceMeter.traceByValue("myTestCount", traceCount); 75 traceCount = 4; 76 hiTraceMeter.traceByValue("myTestCount", traceCount); 77 hiTraceMeter.finishTrace("business", 1); 78 } 79 } 80 ``` 81 822. 新建一个ArkTs应用工程，在“Project”窗口点击“entry > src > main > ets > pages > index”，打开工程中的“index.ets”文件，在页面执行加载后，在自己的业务中调用hiTraceMeter的接口，进行性能打点跟踪，以任务名name为HITRACE_TAG_APP为例 示例代码如下： 83 84 ```ts 85 import hitrace from '@ohos.hiTraceMeter'; 86 87 @Entry 88 @Component 89 struct Index { 90 @State message: string = 'Hello World'; 91 92 build() { 93 Row() { 94 Column() { 95 Text(this.message) 96 .fontSize(50) 97 .fontWeight(FontWeight.Bold) 98 .onClick(() => { 99 this.message = 'Hello ArkUI'; 100 101 // 跟踪并行执行的同名任务 102 hitrace.startTrace("HITRACE_TAG_APP", 1001); 103 // 业务流程 104 console.log(`HITRACE_TAG_APP running`); 105 106 // 第二个跟踪任务开始，同时第一个跟踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 107 hitrace.startTrace("HITRACE_TAG_APP", 1002); 108 // 业务流程 109 console.log(`HITRACE_TAG_APP running`); 110 111 hitrace.finishTrace("HITRACE_TAG_APP", 1001); 112 hitrace.finishTrace("HITRACE_TAG_APP", 1002); 113 114 // 跟踪串行执行的同名任务，taskId可以不同，也可以相同 115 hitrace.startTrace("HITRACE_TAG_APP", 1003); 116 // 业务流程 117 console.log(`HITRACE_TAG_APP running`); 118 //第一个跟踪的任务结束 119 hitrace.finishTrace("HITRACE_TAG_APP", 1003); 120 121 // 第二个跟踪任务开始，同名的待跟踪任务串行执行，且taskId不同 122 hitrace.startTrace("HITRACE_TAG_APP", 1004); 123 // 业务流程 124 console.log(`HITRACE_TAG_APP running`); 125 let traceCount = 3; 126 hitrace.traceByValue("myTestCount", traceCount); 127 hitrace.finishTrace("HITRACE_TAG_APP", 1004); 128 129 // 第三个跟踪任务开始，同名的待跟踪任务串行执行，且taskId与上一个相同 130 hitrace.startTrace("HITRACE_TAG_APP", 1004); 131 // 业务流程 132 console.log(`HITRACE_TAG_APP running`); 133 //第三个跟踪的任务结束 134 hitrace.finishTrace("HITRACE_TAG_APP", 1004); 135 136 }) 137 } 138 .width('100%') 139 } 140 .height('100%') 141 } 142 } 143 ``` 144 1453. 运行项目，点击应用界面上的运行按钮，在shell中依次执行如下命令： 146 147 ```shell 148 hdc shell 149 hitrace --trace_begin app 150 ``` 151 152 执行抓取trace命令后，先在设备中自己的业务里面调用接口，继续依次执行如下命令： 153 154 ```shell 155 hitrace --trace_dump | grep tracing_mark_write 156 hitrace --trace_finish 157 ``` 158 159 抓取trace成功的数据如下所示 160 161 ``` 162 <...>-3310 (-------) [005] .... 351382.921936: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1001 163 <...>-3310 (-------) [005] .... 351382.922138: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1002 164 <...>-3310 (-------) [005] .... 351382.922165: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1001 165 <...>-3310 (-------) [005] .... 351382.922175: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1002 166 <...>-3310 (-------) [005] .... 351382.922182: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1003 167 <...>-3310 (-------) [005] .... 351382.922203: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1003 168 <...>-3310 (-------) [005] .... 351382.922210: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1004 169 <...>-3310 (-------) [005] .... 351382.922233: tracing_mark_write: C|3310|H:myTestCount 3 170 <...>-3310 (-------) [005] .... 351382.922240: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1004 171 <...>-3310 (-------) [005] .... 351382.922247: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1004 172 <...>-3310 (-------) [005] .... 351382.922266: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1004 173 ``` 174