Hatchet项目使用指南：高效分析层次化性能数据

项目概述

Hatchet是一个专为分析层次化性能数据设计的Python工具，特别适合处理调用上下文树(Calling Context Tree)等结构化性能数据。该项目巧妙地将pandas数据框与图结构相结合，为性能分析工程师提供了强大的数据处理能力。

核心数据结构

GraphFrame结构

GraphFrame是Hatchet的核心数据结构，它由两个主要部分组成：

1. Graph对象：存储节点间的边关系，形成有向图结构
2. DataFrame对象：存储每个节点关联的数值指标和分类数据

这种设计使得性能数据既保持了层次关系，又能利用pandas强大的数据分析能力。GraphFrame支持从多种格式导入数据，包括HPCToolkit数据库、Caliper JSON/Cali文件和gprof/callgrind DOT文件等。

节点与路径表示

• 每个节点包含一个frame（由读取器定义）
• 调用路径通过从根节点到目标节点的frame串联形成
• 支持多进程数据，使用节点和MPI rank组成的多级索引

数据导入方法

Hatchet提供了多种便捷的数据导入方式：

# 从HPCToolkit数据库导入
gf = ht.GraphFrame.from_hpctoolkit("database_directory")

# 从Caliper JSON文件导入
gf = ht.GraphFrame.from_caliper("profile.json")

数据可视化技术

Hatchet支持多种可视化方式，满足不同场景需求：

1. 终端树形输出

print(gf.tree())

这种方法适合快速查看小型调用树的结构。

2. Graphviz DOT格式

with open("output.dot", "w") as f:
    f.write(gf.to_dot())

生成DOT文件后，可使用Graphviz工具生成PDF等格式的图形。

3. 火焰图格式

with open("flame.txt", "w") as f:
    f.write(gf.to_flamegraph())

生成的折叠堆栈文件可用flamegraph.pl脚本转换为SVG火焰图。

4. Jupyter交互式可视化

Hatchet提供了Jupyter notebook的交互式可视化功能，支持：

• 鼠标选择节点查看元数据
• 动态隐藏/显示节点
• 生成查询路径用于后续分析

数据框操作

数据过滤

# 使用lambda表达式过滤
filtered_gf = gf.filter(lambda x: x['time'] > 10.0)

# 使用查询对象过滤
query = [
    {"name": "solvers"},
    ("*", {"time (inc)": "> 10"}),
    {"name": "p[a-z]+[0-9]", "time (inc)": ">= 10"}
]
filtered_gf = gf.filter(query)

查询对象语法说明：

• . 匹配一个节点
• * 匹配零或多个节点
• + 匹配一个或多个节点
• 数字 匹配确切数量的节点
• 字典 定义节点过滤条件

数据聚合

# 按节点聚合多进程数据
gf.drop_index_levels(function=np.max)

图结构操作

遍历与压缩

# 前序遍历所有节点
for node in gf.graph.traverse():
    print(node)

# 压缩过滤后的图结构
squashed_gf = filtered_gf.squash()

压缩操作会：

1. 移除被过滤掉的节点
2. 重新连接剩余节点的边关系
3. 重新计算包含性指标

图比较与合并

# 图等价性检查
if gf1 == gf2:
    print("Graphs are equivalent")

# 图合并
unified_gf = gf1.union(gf2)

GraphFrame运算

基本操作

# 复制
gf_copy = gf.copy()

# 深度复制
gf_deepcopy = gf.deepcopy()

数学运算

# 加法运算
result_gf = gf1 + gf2

# 减法运算
result_gf = gf1 - gf2
# 或使用原地操作
gf1 -= gf2

数学运算前会自动执行图合并和重索引操作，确保运算正确性。

最佳实践建议

1. 过滤后压缩：执行filter操作后，建议立即执行squash以保持数据一致性
2. 指标更新：图结构改变后，使用calculate_inclusive_metrics更新包含性指标
3. 可视化选择：根据数据规模选择合适的可视化方式
   • 小型数据：终端树形输出
   • 中型数据：Graphviz图形
   • 大型数据：火焰图
4. 交互分析：在Jupyter环境中使用交互式可视化探索数据

通过掌握这些功能，性能分析工程师可以高效地处理和分析复杂的层次化性能数据，快速定位性能瓶颈和优化机会。