harmony 鸿蒙使用HiTraceMeter跟踪性能（C/C++）
使用HiTraceMeter跟踪性能（C/C++）
简介
HiTraceMeter提供系统性能打点接口。开发者通过在关键代码位置调用HiTraceMeter接口提供的API接口，能够有效跟踪进程轨迹、查看系统性能。
基本概念
HiTraceMeter Tag：跟踪数据使用类别，称作HiTraceMeter Tag，一般每个软件子系统对应一个tag。hitrace命令行工具采集跟踪数据时，只采集给定的tag类别选项指定的跟踪数据。应用中的HiTraceMeter打点的tag是HITRACE_TAG_APP，对应hitrace命令hitrace -l列出的tag列表中的app。
实现原理
- 应用程序通过HiTraceMeter函数接口进行打点，HiTraceMeter函数将跟踪数据通过内核sysfs文件接口输入到内核的ftrace数据缓冲区。
- hitrace命令行工具读取内核ftrace缓冲区中的跟踪数据，将文本格式的跟踪数据输出到设备侧的文件中。
接口说明
性能打点跟踪接口由HiTraceMeter模块提供，详细API请参考性能打点跟踪API参考。
| 方法 | 接口描述 |
|---|---|
| void OH_HiTrace_StartTraceEx(HiTrace_Output_Level level, const char* name, const char* customArgs) | 开启一个同步时间片跟踪事件，分级控制跟踪输出。 说明：从API version 19开始，支持该接口。 |
| void OH_HiTrace_FinishTraceEx(HiTrace_Output_Level level) | 结束一个同步时间片跟踪事件，分级控制跟踪输出。level必须与流程开始的OH_HiTrace_StartTraceEx对应参数值保持一致。 说明：从API version 19开始，支持该接口。 |
| void OH_HiTrace_StartAsyncTraceEx(HiTrace_Output_Level level, const char* name, int32_t taskId, const char* customCategory, const char* customArgs) | 开启一个异步时间片跟踪事件，分级控制跟踪输出。taskId是trace中用来表示关联的ID，如果有多个name相同的任务并行执行，则开发者每次调用OH_HiTrace_StartAsyncTraceEx时传入的taskId需不同；如果具有相同name的任务是串行执行的，则taskId可以相同。 说明：从API version 19开始，支持该接口。 |
| void OH_HiTrace_FinishAsyncTraceEx(HiTrace_Output_Level level, const char* name, int32_t taskId) | 结束一个异步时间片跟踪事件，分级控制跟踪输出。level、name和taskId必须与流程开始的OH_HiTrace_StartAsyncTraceEx对应参数值保持一致。 说明：从API version 19开始，支持该接口。 |
| void OH_HiTrace_CountTraceEx(HiTrace_Output_Level level, const char* name, int64_t count) | 整数跟踪事件，分级控制跟踪输出。用来标记一个预跟踪的整数变量，该变量的数值会不断变化。 说明：从API version 19开始，支持该接口。 |
| bool OH_HiTrace_IsTraceEnabled(void) | 判断当前是否开启应用trace捕获。应用trace捕获未开启时，HiTraceMeter性能跟踪打点无效。 说明：从API version 19开始，支持该接口。 |
注意：
用户态trace格式使用竖线
|作为分隔符，所以通过HiTraceMeter接口传递的字符串类型参数应避免包含该字符，防止trace解析异常。
HiTraceMeter打点接口按功能/行为分类，主要分三类：同步时间片跟踪接口、异步时间片跟踪接口和整数跟踪接口。无论同步时间片跟踪接口还是异步时间片跟踪接口，接口本身都是同步接口，不是异步接口。HiTraceMeter打点接口可与HiTraceChain一起使用，进行跨设备/跨进程/跨线程的打点关联与分析。
- 同步时间片跟踪接口用于顺序执行的打点场景。
- 异步时间片跟踪接口用于在异步操作执行前进行开始打点，在异步操作完成后进行结束打点。异步跟踪的开始和结束由于不是顺序发生的，解析trace时需要通过name与taskId参数进行识别，name与taskId参数相同的异步跟踪开始与结束打点相匹配。
- 整数跟踪接口用于跟踪整数变量。
参数解析
| 参数名 | 类型 | 说明 |
|---|---|---|
| level | enum | 跟踪输出级别，低于系统阈值的跟踪将不会被输出。 log版本阈值为HITRACE_LEVEL_INFO，nolog版本阈值为HITRACE_LEVEL_COMMERCIAL。 |
| name | const char* | 要跟踪的任务名称或整数变量名称。 |
| taskId | int32_t | 用来表示关联的ID，如果有多个name相同的任务是并行执行的，则开发者每次调用OH_HiTrace_StartAsyncTraceEx时传入的taskId需不同。 |
| count | int64_t | 整数变量的值。 |
| customCategory | const char* | 自定义聚类名称，用于聚合同一类异步跟踪打点。 若不需要聚类，可传入一个空字符串。 |
| customArgs | const char* | 自定义键值对，若有多组键值对，使用逗号进行分隔，例”key1=value1,key2=value2”。 若不需要该参数，可传入一个空字符串。 |
说明：
用户态trace总长度限制512字符，超过的部分将会被截断，因此建议name、customCategory和customArgs三个字段的总长度不超过420字符，避免输出的用户态trace被截断。
开发示例
在DevEco Studio中创建Native C++工程，使用HiTraceMeter NDK_C打点接口，以下为一个Native C++工程示例。
- 新建一个Native C++工程，工程目录结构如下：
├── entry
│ ├── src
│ ├── main
│ │ ├── cpp
│ │ │ ├── CMakeLists.txt
│ │ │ ├── napi_init.cpp
│ │ │ └── types
│ │ │ └── libentry
│ │ │ ├── Index.d.ts
│ │ │ └── oh-package.json5
│ │ ├── ets
│ │ │ ├── entryability
│ │ │ │ └── EntryAbility.ets
│ │ │ ├── entrybackupability
│ │ │ │ └── EntryBackupAbility.ets
│ │ │ └── pages
│ │ │ └── Index.ets
- 在”CMakeLists.txt”文件末尾新增如下内容，添加libhitrace_ndk.z.so和libhilog_ndk.z.so动态链接库。
target_link_libraries(entry PUBLIC libhitrace_ndk.z.so libhilog_ndk.z.so)
- 编辑”napi_init.cpp”文件，在Add函数中调用HiTraceMeter NDK_C的接口，进行性能打点跟踪， 示例代码如下：
#include <cstdio>
#include <cstring>
#include "hilog/log.h"
#include "hitrace/trace.h"
#include "napi/native_api.h"
#undef LOG_TAG
#define LOG_TAG "traceTest"
static napi_value Add(napi_env env, napi_callback_info info)
{
// 第一个异步跟踪任务开始
OH_HiTrace_StartAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1001, "categoryTest", "key=value");
// 开始计数任务
int64_t traceCount = 0;
traceCount++;
OH_HiTrace_CountTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestCountTrace", traceCount);
// 业务流程
OH_LOG_INFO(LogType::LOG_APP, "myTraceTest running, taskId: 1001");
// 第二个异步跟踪任务开始，同时第一个跟踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同
OH_HiTrace_StartAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1002, "categoryTest", "key=value");
// 开始计数任务
traceCount++;
OH_HiTrace_CountTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestCountTrace", traceCount);
// 业务流程
OH_LOG_INFO(LogType::LOG_APP, "myTraceTest running, taskId: 1002");
// 结束taskId为1001的异步跟踪任务
OH_HiTrace_FinishAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1001);
// 结束taskId为1002的异步跟踪任务
OH_HiTrace_FinishAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1002);
// 开始同步跟踪任务
OH_HiTrace_StartTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestSyncTrace", "key=value");
// 业务流程
OH_LOG_INFO(LogType::LOG_APP, "myTraceTest running, synchronizing trace");
// 结束同步跟踪任务
OH_HiTrace_FinishTraceEx(HITRACE_LEVEL_COMMERCIAL);
// 若通过HiTraceMeter性能打点接口传递的参数的生成过程比较复杂，此时可以通过isTraceEnabled判断当前是否开启应用trace捕获，
// 在未开启应用trace捕获时，避免该部分性能损耗
if (OH_HiTrace_IsTraceEnabled()) {
char customArgs[128] = "key0=value0";
for (int index = 1; index < 10; index++) {
char buffer[16];
snprintf(buffer, sizeof(buffer), ",key%d=value%d", index, index);
strncat(customArgs, buffer, sizeof(customArgs) - strlen(customArgs) - 1);
}
OH_HiTrace_StartAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1003, "categoryTest", customArgs);
OH_LOG_INFO(LogType::LOG_APP, "myTraceTest running, taskId: 1003");
OH_HiTrace_FinishAsyncTraceEx(HITRACE_LEVEL_COMMERCIAL, "myTestAsyncTrace", 1003);
} else {
OH_LOG_INFO(LogType::LOG_APP, "myTraceTest running, trace is not enabled");
}
size_t requireArgc = 2;
size_t argc = 2;
napi_value args[2] = {nullptr};
napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);
napi_valuetype valuetype0;
napi_typeof(env, args[0], &valuetype0);
napi_valuetype valuetype1;
napi_typeof(env, args[1], &valuetype1);
double value0;
napi_get_value_double(env, args[0], &value0);
double value1;
napi_get_value_double(env, args[1], &value1);
napi_value sum;
napi_create_double(env, value0 + value1, &sum);
return sum;
}
EXTERN_C_START
static napi_value Init(napi_env env, napi_value exports)
{
napi_property_descriptor desc[] = {
{ "add", nullptr, Add, nullptr, nullptr, nullptr, napi_default, nullptr }
};
napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
return exports;
}
EXTERN_C_END
static napi_module demoModule = {
.nm_version = 1,
.nm_flags = 0,
.nm_filename = nullptr,
.nm_register_func = Init,
.nm_modname = "entry",
.nm_priv = ((void*)0),
.reserved = { 0 },
};
extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
{
napi_module_register(&demoModule);
}
- 在DevEco Studio Terminal窗口中执行如下命令，开启应用trace捕获：
PS D:\xxx\xxx> hdc shell
$ hitrace --trace_begin app
- 单击DevEco Studio界面上的运行按钮，启动应用，点击屏幕中间的字符串，执行包含HiTraceMeter打点的业务逻辑，然后执行如下命令抓取trace数据：
$ hitrace --trace_dump|grep myTest
成功抓取的trace数据如下所示：
<...>-49837 (-------) [002] .... 349137.708093: tracing_mark_write: S|49837|H:myTestAsyncTrace|1001|M62|categoryTest|key=value
<...>-49837 (-------) [002] .... 349137.708103: tracing_mark_write: C|49837|H:myTestCountTrace|1|M62
<...>-49837 (-------) [002] .... 349137.708201: tracing_mark_write: S|49837|H:myTestAsyncTrace|1002|M62|categoryTest|key=value
<...>-49837 (-------) [002] .... 349137.708209: tracing_mark_write: C|49837|H:myTestCountTrace|2|M62
<...>-49837 (-------) [002] .... 349137.708239: tracing_mark_write: F|49837|H:myTestAsyncTrace|1001|M62
<...>-49837 (-------) [002] .... 349137.708246: tracing_mark_write: F|49837|H:myTestAsyncTrace|1002|M62
<...>-49837 (-------) [002] .... 349137.708252: tracing_mark_write: B|49837|H:myTestSyncTrace|M62|key=value
<...>-49837 (-------) [002] .... 349137.708301: tracing_mark_write: S|49837|H:myTestAsyncTrace|1003|M62|categoryTest|key0=value0,key1=value1,key2=value2,key3=value3,key4=value4,key5=value5,key6=value6,key7=value7,key8=value8,key9=value9
<...>-49837 (-------) [002] .... 349137.708323: tracing_mark_write: F|49837|H:myTestAsyncTrace|1003|M62
- 执行如下命令，结束应用trace捕获：
$ hitrace --trace_finish
- 再次点击屏幕中间的字符串，此时应用trace捕获已关闭，OH_HiTrace_IsTraceEnabled返回false，DevEco Studio Log窗口使用关键字”enable”进行过滤，出现如下打印：
myTraceTest running, trace is not enabled
你可能感兴趣的鸿蒙文章
0
赞
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦