如何在C API中使用babeltrace2-sink.text.pretty组件打印LTTng trace格式化文本

完全可以直接调用babeltrace2-sink.text.pretty实现需求，该组件是Babeltrace2官方原生提供的标准sink组件，设计目标就是将trace事件格式化为人类可读的文本输出，命令行调用和C API调用的组件能力完全一致。

核心实现逻辑 #

Babeltrace2的组件模型不区分调用方式，你只需要按照标准trace处理流程搭建组件图即可：

• 创建Babeltrace2图（bt_graph）实例
• 添加source.ctf.fs类型的source组件，传入LTTng trace的目录路径作为参数，负责读取CTF格式的trace数据
• 添加sink.text.pretty类型的sink组件到图中，需输出到指定文件时传入path参数，不传默认输出到标准输出
• 连接source组件的输出端口到sink组件的输入端口
• 运行图直到所有trace处理完成
• 销毁所有创建的资源避免内存泄漏

简化代码示例 #

#include <babeltrace2/babeltrace.h>

int main(int argc, char const *argv[]) {
    bt_graph *graph = NULL;
    const bt_component_class_source *src_cc = NULL;
    const bt_component_class_sink *sink_cc = NULL;
    bt_component *src_comp = NULL, *sink_comp = NULL;
    bt_value *params = NULL;
    bt_graph_run_status run_status;

    // 初始化处理图
    graph = bt_graph_create();
    // 获取source.ctf.fs组件类
    src_cc = bt_component_class_source_find("source.ctf.fs");
    // 配置trace路径参数
    params = bt_value_map_create();
    bt_value_map_insert_string_entry(params, "inputs", "/path/to/your/lttng/trace");
    // 将source组件添加到图中
    bt_graph_add_source_component(graph, src_cc, "lttng_src", params, BT_LOGGING_LEVEL_NONE, &src_comp);
    bt_value_put_ref(params);

    // 获取sink.text.pretty组件类
    sink_cc = bt_component_class_sink_find("sink.text.pretty");
    // 将sink组件添加到图中，此处用默认参数输出到stdout，需输出到文件可传入带path参数的params
    bt_graph_add_sink_component(graph, sink_cc, "pretty_sink", NULL, BT_LOGGING_LEVEL_NONE, &sink_comp);

    // 连接两个组件的端口
    bt_graph_connect_ports(graph,
        bt_component_borrow_output_port_by_index_const(src_comp, 0),
        bt_component_borrow_input_port_by_index_const(sink_comp, 0),
        NULL);

    // 运行图处理全量trace
    run_status = bt_graph_run(graph, NULL, NULL, NULL);

    // 释放所有引用计数
    bt_component_put_ref(src_comp);
    bt_component_put_ref(sink_comp);
    bt_graph_put_ref(graph);
    return 0;
}

编译时需要链接babeltrace2库，参考编译命令：gcc your_code.c -o lttng_pretty_print $(pkg-config --cflags --libs babeltrace2)

注意事项 #

• 可通过传入参数调整sink.text.pretty的输出格式，比如控制是否打印事件名、时间戳格式、是否展示事件负载等，具体参数定义可参考Babeltrace2官方组件说明
• 如有多trace合并、时间范围裁剪等需求，可在source和sink之间插入对应filter组件，不影响sink组件的调用逻辑
• 所有Babeltrace2的对象都基于引用计数管理，操作完成后必须调用对应put_ref方法释放引用，避免内存泄漏

内容的提问来源于stack exchange，提问作者OhioDschungel6