oeAware-scenario开发者指南：如何编写自定义场景感知插件

oeAware-scenario开发者指南：如何编写自定义场景感知插件

【免费下载链接】oeAware-scenarioProvides low-overhead scenario awareness项目地址: https://gitcode.com/openeuler/oeAware-scenario

前往项目官网免费下载：https://ar.openeuler.org/ar/

oeAware-scenario是openEuler生态下的轻量级场景感知工具，通过低开销的系统监控实现应用场景的智能识别。本指南将帮助开发者快速掌握自定义场景感知插件的开发流程，从环境准备到插件部署的完整步骤。

一、开发环境准备

1.1 安装基础依赖

确保系统已安装g++、cmake和openEuler开发工具链：

sudo dnf install -y gcc-c++ cmake make

1.2 获取源代码

克隆官方仓库到本地：

git clone https://gitcode.com/openeuler/oeAware-scenario cd oeAware-scenario

二、插件开发核心概念

2.1 插件接口规范

所有场景感知插件必须实现Interface结构体定义的标准接口，位于thread_aware/thread_aware.cpp：

• get_name(): 返回插件名称
• get_dep(): 声明依赖的采集器插件
• enable()/disable(): 插件生命周期管理
• run(): 核心数据处理逻辑
• get_ring_buf(): 提供处理结果数据

2.2 数据结构定义

场景数据通过统一格式传递，核心结构体定义在example/include/for_tune/scenario_plugin.h:

struct uncore_scenario { float numa_score; // NUMA架构感知评分 };

三、五步开发自定义插件

3.1 定义插件元信息

创建插件实现文件（如my_scenario.cpp），首先定义基础信息：

char name[] = "my_custom_scenario"; // 插件名称 char dep[] = "system_collector"; // 依赖的采集器 const int CYCLE_SIZE = 200; // 处理周期(ms)

3.2 实现生命周期函数

初始化和清理资源：

bool enable() { // 读取配置文件 [thread_aware/thread_scenario.conf](https://link.gitcode.com/i/8204e971eec17e53a06d07cc8df531e3) read_key_list(CONFIG_PATH); // 初始化数据缓冲区 return true; } void disable() { // 释放资源 key_list.clear(); }

3.3 编写核心处理逻辑

在run()函数中实现场景识别算法：

void run(const Param *param) { // 从采集器获取原始数据 auto *header = param->ring_bufs[0]; DataBuf buf = header->buf[header->count % header->buf_len]; // 场景分析处理 for (int i = 0; i < buf.len; ++i) { // 实现自定义场景识别逻辑 analyze_scenario(data[i]); } // 结果写入输出缓冲区 data_buf.len = result_count; data_buf.data = results.data(); }

3.4 配置CMake构建脚本

创建插件目录的CMakeLists.txt：

add_library(my_scenario SHARED my_scenario.cpp) target_include_directories(my_scenario PRIVATE ${PROJECT_SOURCE_DIR}/include ${PROJECT_SOURCE_DIR}/example/include) install(TARGETS my_scenario DESTINATION /usr/lib64/oeAware-plugin)

3.5 编译与安装

mkdir build && cd build cmake .. make -j4 sudo make install

四、插件调试与验证

4.1 配置文件管理

插件配置文件需放置在标准路径：

/usr/lib64/oeAware-plugin/my_scenario.conf

4.2 日志与监控

通过分析模块查看插件运行状态：

// 参考 [analysis/analysis/analysis.cpp](https://link.gitcode.com/i/92097e271f1f246ddd9d5967c2987c67) std::cout << "my_scenario plugin period is " << get_period() << " ms" << std::endl;

4.3 功能测试

使用官方测试框架验证插件功能：

cd tests ./test_scenario_plugin --name my_custom_scenario

五、最佳实践

5.1 性能优化

• 控制处理周期，避免过度消耗CPU
• 使用环形缓冲区thread_aware/thread_aware.cpp减少内存分配
• 优先使用栈内存而非堆内存

5.2 依赖管理

明确声明采集器依赖，如线程场景插件依赖thread_collector：

const char* get_dep() { return "thread_collector"; }

5.3 代码规范

遵循项目现有代码风格，关键函数添加Doxygen注释：

/** * @brief 场景分析主函数 * @param data 原始采集数据 * @return 场景识别结果 */ ScenarioResult analyze_scenario(const RawData &data);

六、参考资源

• 官方示例插件：example/scenario/
• 接口定义：include/scenario.h
• 线程场景实现：thread_aware/thread_aware.cpp

通过以上步骤，开发者可以快速构建符合oeAware-scenario规范的场景感知插件，为系统提供定制化的场景识别能力。如需进一步优化性能，可参考分析模块的实现analysis/analysis/中的算法设计。

【免费下载链接】oeAware-scenarioProvides low-overhead scenario awareness项目地址: https://gitcode.com/openeuler/oeAware-scenario