如何在Boost.Log配置的文件名及目标路径中使用自定义属性

问题原因 #

首先明确两个直接导致你配置不生效的核心原因：

1. Boost.Log 配置文件中的FileName字段默认仅支持静态内置占位符（如时间戳、文件滚动序号%N%等），不会动态读取单条日志条目携带的自定义属性值，所以直接写%THREAD_ID%无法解析。
2. 你配置中写的%THREAD_ID%和代码里注册的属性名Thread_ID大小写不匹配，就算支持动态解析也无法正确获取属性值。

实现方案 #

你不需要完全放弃配置文件的加载逻辑，只需要在boost::log::init_from_stream执行完成后，额外添加一段代码给文件日志后端设置动态文件名生成器即可，配置文件里的格式、过滤器、滚动大小、自动刷写等原有配置仍然可以正常生效。

方案1：兼容现有配置的修改方案 #

在配置加载完成后，遍历获取初始化好的文本文件sink，给后端绑定自定义文件名生成逻辑：

#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/expressions.hpp>
#include <boost/smart_ptr/dynamic_pointer_cast.hpp>

namespace logging = boost::log;
namespace sinks = boost::log::sinks;
namespace expr = boost::log::expressions;

// 执行完boost::log::init_from_stream加载配置后执行以下逻辑
void config_dynamic_filename() {
    // 获取所有已注册的sink
    auto all_sinks = logging::core::get()->get_sinks();
    for (const auto& sink : all_sinks) {
        // 匹配异步文本文件sink，如果你用的是同步sink就把asynchronous_sink换成synchronous_sink
        auto file_sink = boost::dynamic_pointer_cast<sinks::asynchronous_sink<sinks::text_file_backend>>(sink);
        if (!file_sink) {
            continue;
        }
        // 加锁获取backend指针
        auto backend = file_sink->locked_backend();
        // 设置动态文件名生成规则，支持自定义任意属性拼接路径和文件名
        backend->set_file_name_composer(
            expr::stream << "C:\\BoostLogTrace\\REST_"
            // 这里属性名要和你注册的一致，模板参数要和属性存储的类型匹配
            << expr::attr<std::string>("Thread_ID")
            << "_"
            // 可以同时拼接多个属性，比如按会话ID拆分目录
            << expr::attr<std::string>("Correlation_ID")
            << ".log"
            // 如果属性可能为空，用or_else设置默认值避免生成非法文件名
            // << expr::or_else(expr::attr<std::string>("Correlation_ID"), "common")
        );
    }
}

注意：如果要拆分目录，直接在路径拼接逻辑里加入属性即可，Boost.Log会自动创建不存在的子目录。

方案2：高并发多会话场景专用方案 #

如果你需要按用户会话拆分日志，且同时在线的会话数量较多，推荐直接使用sinks::text_multifile_backend，这个后端天生支持按属性值动态路由日志到不同文件，内部会自动管理文件句柄的打开/关闭，性能更稳定：

auto multifile_backend = boost::make_shared<sinks::text_multifile_backend>();
// 直接通过占位符设置文件名规则，支持所有已注册的自定义属性
multifile_backend->set_file_name_pattern("C:\\BoostLogTrace\\%Correlation_ID%\\REST_%Thread_ID%.log");
// 可选：配置最大同时打开的文件数，避免句柄耗尽
multifile_backend->set_max_open_files(100);

// 构造sink，设置格式、过滤器等参数，也可以从配置文件解析参数复用原有配置
typedef sinks::asynchronous_sink<sinks::text_multifile_backend> multifile_sink_t;
auto sink = boost::make_shared<multifile_sink_t>(multifile_backend);
// 原有配置里的格式、过滤器、自动刷写等配置可以直接迁移或者从配置读取后设置
sink->set_formatter(/* 你的日志格式逻辑 */);
sink->set_filter(expr::attr<logging::trivial::severity_level>("Severity") == logging::trivial::trace);
sink->locked_backend()->auto_flush(true);

// 注册到日志核心
logging::core::get()->add_sink(sink);

额外注意事项 #

• 自定义属性的名称大小写、expr::attr的模板参数类型必须和你注册属性时的定义完全一致，否则会无法读取属性值
• 如果使用异步sink，必须通过locked_backend()方法获取后端指针，避免多线程环境下的并发冲突
• 文件名生成规则中如果包含特殊字符，建议提前对属性值做合法性校验，避免生成非法的文件路径

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