性能打点跟踪开发指导


性能打点跟踪开发指导

简介

hiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口,能够有效跟踪进程轨迹、查看系统性能。

基本概念

  • hiTraceMeter Tag

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

实现原理

  • 应用程序通过hiTraceMeter函数接口进行打点,hiTraceMeter函数将跟踪数据通过内核sysfs文件接口输出到内核的ftrace数据缓冲区。
  • hiTraceMeter命令行工具读取内核ftrace缓冲区中的跟踪数据,将文本格式的跟踪数据保存到设备侧的文件中。

约束与限制

  • 由于JS程序的异步IO特性,现在hiTraceMeter只提供了异步接口。

接口说明

性能打点跟踪接口由hiTraceMeter模块提供,详细API请参考性能打点跟踪API参考

性能打点跟踪接口功能介绍:

接口名 返回值 描述
hiTraceMeter.startTrace(name: string, taskId: number) void 标记一个预跟踪耗时任务的开始。如果有多个相同name的任务需要跟踪或者对同一个任务要跟踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。如果具有相同name的任务是串行执行的,则taskId可以相同。
hiTraceMeter.finishTrace(name: string, taskId: number) void name和taskId必须与流程开始的hiTraceMeter.startTrace对应参数值保持一致。
hiTraceMeter.traceByValue(name: string, value: number) void 用来标记一个预跟踪的数值变量,该变量的数值会不断变化。

开发步骤

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

  1. 新建一个JS应用工程,在“Project”窗口点击“entry > src > main > js > default > pages > index”,打开工程中的“index.js”文件,在页面执行加载后,在自己的业务中调用hiTraceMeter的接口,进行性能打点跟踪,示例代码如下:

    import hiTraceMeter from '@ohos.hiTraceMeter'
    
    export default {
        data: {
            title: ""
        },
        onInit() {
            this.title = this.$t('strings.world');
    
            // 跟踪并行执行的同名任务
            hiTraceMeter.startTrace("business", 1);
            // 业务流程
            console.log(`business running`);
            hiTraceMeter.startTrace("business", 2);  // 第二个跟踪任务开始,同时第一个跟踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
            // 业务流程
            console.log(`business running`);
            hiTraceMeter.finishTrace("business", 1);
            // 业务流程
            console.log(`business running`);
            hiTraceMeter.finishTrace("business", 2);
    
            // 跟踪串行执行的同名任务
            hiTraceMeter.startTrace("business", 1);
            // 业务流程
            console.log(`business running`);
            hiTraceMeter.finishTrace("business", 1);  // 第一个跟踪的任务结束
            // 业务流程
            console.log(`business running`);
            hiTraceMeter.startTrace("business", 1);   // 第二个跟踪的同名任务开始,同名的待跟踪任务串行执行。
            // 业务流程
            console.log(`business running`);
    
            let traceCount = 3;
            hiTraceMeter.traceByValue("myTestCount", traceCount);
            traceCount = 4;
            hiTraceMeter.traceByValue("myTestCount", traceCount);
            hiTraceMeter.finishTrace("business", 1);
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
  2. 运行项目,点击应用界面上的运行按钮,即可通过日志信息分析实际业务。