easy_profiler 使用手册

easy_profiler 使用手册

easy_profiler Lightweight profiler library for c++ 项目地址: https://gitcode.com/gh_mirrors/ea/easy_profiler

安装指南

获取源码

首先，从Github下载最新的源码包，或者通过Git克隆仓库。

预先条件

确保您的开发环境满足以下要求：

• CMake 3.0 或更高版本。
• 支持C++11的编译器（对于Unix系统，建议使用支持thread_local的编译器，如GCC 4.8+或Clang 3.3+）。
• 对于GUI部分，需要Qt 5.3.0或以上版本。

构建步骤

在Linux上构建

1. 创建一个构建目录并进入该目录。

   mkdir build && cd build
   

2. 执行CMake命令以配置构建，并指定释放模式。

   cmake -DCMAKE_BUILD_TYPE="Release" ..
   

3. 运行make来编译项目。

   make
   

在MacOS上构建

若使用不同的C++编译器，例如g++-5：

mkdir build && cd build
cmake -DCMAKE_CXX_COMPILER=g++-5 -DCMAKE_C_COMPILER=gcc-5 -DCMAKE_BUILD_TYPE="Release" ..
make

在Windows上构建

推荐使用CMake与Visual Studio或Qt Creator配合工作。在命令行下生成解决方案：

mkdir build && cd build
cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE="Release" ..

然后，在Visual Studio中打开生成的解决方案文件并构建。

项目的使用说明

整合到项目中

• 一般集成方法：定义BUILD_WITH_EASY_PROFILER宏，并包含路径至包含有include/profiler的目录。手动链接库到项目中。
• CMake用户：设置CMAKE_PREFIX_PATH指向lib/cmake/easy_profiler目录，并使用find_package(easy_profiler)，接着将easy_profiler链接到你的目标。

插入性能分析块

使用EASY_FUNCTION宏标记函数，EASY_BLOCK用于代码段，它们可自定义颜色，并且通过析构自动结束无需显式EASY_END_BLOCK。

存储变量值

通过EASY_VALUE和EASY_ARRAY宏存储变量及其数组值，以便在分析结果中查看。

数据收集

网络流式传输

• 应用程序端调用profiler::startListen()监听特定端口。
• GUI连接至应用并通过UI启动捕获。
• 结束时，GUI停止捕获并接收数据。

文件转储

使用EASY_PROFILER_ENABLE启用分析，然后利用profiler::dumpBlocksToFile("filename.prof")保存数据到文件。

API使用文档

• EASY_FUNCTION(color)：标识一个函数的开始，可选颜色参数。
• EASY_BLOCK(block_name, color)：标记一个代码块开始，颜色可选。
• EASY_END_BLOCK：手动结束一个代码块（通常由块作用域结束自动处理）。
• EASY_VALUE(name, value[, identifier])：记录单个变量的值，可指定唯一ID保持恒定。
• EASY_ARRAY(name, array_address, count, color)：记录数组的值，同样支持自定义色标。

项目特点回顾

• 极低的开销和内存占用。
• 跨平台兼容性。
• 支持网络远程分析。
• 捕捉线程上下文切换。
• 动态变量存储。
• 强大的GUI统计与展示。

通过遵循上述步骤，您可以轻松地将easy_profiler集成到C++项目中，实现高效的性能监控和分析。

easy_profiler Lightweight profiler library for c++ 项目地址: https://gitcode.com/gh_mirrors/ea/easy_profiler