使用HiTraceMeter跟踪性能（ArkTS/JS）

简介

HiTraceMeter提供系统性能打点接口。开发者通过在关键代码位置调用HiTraceMeter接口提供的API接口，能够有效跟踪进程轨迹、查看系统性能。

基本概念

HiTraceMeter Tag：跟踪数据使用类别分类，称作HiTraceMeter Tag或HiTraceMeter Category。一般每个软件子系统对应一个Tag，该Tag在打点API中以类别Tag参数传入。HiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。

实现原理

1. 应用程序通过HiTraceMeter函数接口进行打点，HiTraceMeter函数将跟踪数据通过内核sysfs文件接口输出到内核的ftrace数据缓冲区。

2. HiTraceMeter命令行工具读取内核ftrace缓冲区中的跟踪数据，将文本格式的跟踪数据保存到设备侧的文件中。

约束与限制

由于JS程序的异步IO特性，目前HiTraceMeter只提供了异步接口。

接口说明

性能打点跟踪接口由HiTraceMeter模块提供，详细API请参考性能打点跟踪API参考。

开发步骤

在应用启动执行页面加载后，开始分布式跟踪；完成业务之后，停止分布式跟踪。

1. 新建一个ArkTS应用工程，在“Project”窗口点击“entry > src > main > ets > pages > index”，打开工程中的“index.ets”文件；在页面执行加载后，在自己的业务中调用hiTraceMeter的接口，进行性能打点跟踪，以任务名name为HITRACE_TAG_APP为例， 示例代码如下：

   import hitrace from '@ohos.hiTraceMeter';
   
   @Entry
   @Component
   struct Index {
     @State message: string = 'Hello World';
   
     build() {
       Row() {
         Column() {
           Text(this.message)
             .fontSize(50)
             .fontWeight(FontWeight.Bold)
             .onClick(() => {
               this.message = 'Hello ArkUI';
   
               // 跟踪并行执行的同名任务
               hitrace.startTrace("HITRACE_TAG_APP", 1001);
               // 业务流程
               console.log(`HITRACE_TAG_APP running`);
   
               // 第二个跟踪任务开始，同时第一个跟踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。
               hitrace.startTrace("HITRACE_TAG_APP", 1002);
               // 业务流程
               console.log(`HITRACE_TAG_APP running`);
   
               hitrace.finishTrace("HITRACE_TAG_APP", 1001);
               hitrace.finishTrace("HITRACE_TAG_APP", 1002);
   
               // 跟踪串行执行的同名任务，taskId可以不同，也可以相同
               hitrace.startTrace("HITRACE_TAG_APP", 1003);
               // 业务流程
               console.log(`HITRACE_TAG_APP running`);
               //第一个跟踪的任务结束
               hitrace.finishTrace("HITRACE_TAG_APP", 1003);
   
               // 第二个跟踪任务开始，同名的待跟踪任务串行执行，且taskId不同
               hitrace.startTrace("HITRACE_TAG_APP", 1004);
               // 业务流程
               console.log(`HITRACE_TAG_APP running`);
               let traceCount = 3;
               hitrace.traceByValue("myTestCount", traceCount);
               hitrace.finishTrace("HITRACE_TAG_APP", 1004);
   
               // 第三个跟踪任务开始，同名的待跟踪任务串行执行，且taskId与上一个相同
               hitrace.startTrace("HITRACE_TAG_APP", 1004);
               // 业务流程
               console.log(`HITRACE_TAG_APP running`);
               //第三个跟踪的任务结束
               hitrace.finishTrace("HITRACE_TAG_APP", 1004);
   
             })
          }
          .width('100%')
        }
        .height('100%')
      }
   }
   

2. 运行项目，单击IDE界面上的运行按钮，在shell中依次执行如下命令：

   hdc shell
   hitrace --trace_begin app
   

   执行抓取trace命令后，先在设备中自己的业务调用接口，继续依次执行如下命令：

   hitrace --trace_dump | grep tracing_mark_write
   hitrace --trace_finish
   

   抓取trace成功的数据如下所示：

   <...>-3310    (-------) [005] .... 351382.921936: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1001
   <...>-3310    (-------) [005] .... 351382.922138: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1002
   <...>-3310    (-------) [005] .... 351382.922165: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1001
   <...>-3310    (-------) [005] .... 351382.922175: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1002
   <...>-3310    (-------) [005] .... 351382.922182: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1003
   <...>-3310    (-------) [005] .... 351382.922203: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1003
   <...>-3310    (-------) [005] .... 351382.922210: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1004
   <...>-3310    (-------) [005] .... 351382.922233: tracing_mark_write: C|3310|H:myTestCount 3
   <...>-3310    (-------) [005] .... 351382.922240: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1004
   <...>-3310    (-------) [005] .... 351382.922247: tracing_mark_write: S|3310|H:HITRACE_TAG_APP 1004
   <...>-3310    (-------) [005] .... 351382.922266: tracing_mark_write: F|3310|H:HITRACE_TAG_APP 1004