促进共享库中的日志记录通道过滤在Linux

时间:2015-07-27 15:57:00

标签: c++ linux boost-log

我有一个Linux和Windows的可执行文件,有三个dll /共享库,我正在使用boost.log进行日志记录。我希望每个模块都有一个单独的文件日志。我的方法是为每个模块创建一个severity_channel_logger_mt,为每个模块构建一个带有通道名称的模块。

class LogSingleton final
{
  src::severity_channel_logger_mt<logging::trivial::severity_level, std::string> slg_;
...
protected:
  LogSingleton() : slg_(boost::log::keywords::channel = "ModuleOne") {}
public:
  src::severity_channel_logger_mt<logging::trivial::severity_level, std::string>& logger() { return slg_; }
...
};    

然后每个模块在初始化时创建自己的文件接收器,并设置一个通道过滤器,以便只有该模块的日志消息才能到达此接收器。

logging::add_file_log(logging::keywords::file_name = "module_one.log",
  logging::keywords::open_mode = std::ios::app,
  ->set_filter(logging::trivial::severity >= level 
    && expr::attr< std::string >("Channel") == "ModuleOne");

然后我创建了自己的模块特定宏来进行日志记录,该宏传递给正确的记录器。

#define BLOG(lvl)  BOOST_LOG_STREAM_WITH_PARAMS((LogSingleton::instance()->logger()), (::boost::log::keywords::severity = ::boost::log::trivial::lvl))

使用如下:

BLOG(info) << "Hello world";

虽然在Windows上日志记录按预期工作,但在Linux上,ModuleOne(首先初始化)和ModuleThree(初始化第三个)的日志文件不会收到任何日志消息。 ModuleTwo正确记录。除了日志接收器文件名,通道名称和单例的类名之外,所有三个模块的日志记录代码都是相同的。

我想知道问题是否与我的宏有关,但欢迎任何想法,以及对方法的评论。

更新

我已将此问题简化为最小的示例,所有这些都在一个可执行文件中。共享库问题是误导。问题似乎是如果我在单例中创建severity_channel_logger,则日志记录失败。如果我使用本地记录器,则记录有效。即使我在单例中创建了一个记录器而不使用它,它也会阻止本地记录器运行。尽管追查代码,但我不明白为什么会发生这种情况。 (平台= Fedora 21,gcc 4.9.2,提升1.58)

#include <boost/config.hpp> 
#include <boost/filesystem.hpp>
#include <boost/log/core.hpp>
#include <boost/log/trivial.hpp>
#include <boost/log/sources/severity_feature.hpp>
#include <boost/log/sources/severity_channel_logger.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/expressions/formatters/date_time.hpp>
#include <boost/log/support/date_time.hpp>
#include <boost/log/attributes/current_thread_id.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>

namespace logging = boost::log;
namespace expr = boost::log::expressions;
namespace src = boost::log::sources;
namespace fs = boost::filesystem;

class LogSingleton
{
    src::severity_channel_logger<logging::trivial::severity_level, std::string> slg_;
    static LogSingleton* instance_;

    LogSingleton(const LogSingleton&);
    LogSingleton& operator=(const LogSingleton&);

protected:
    LogSingleton() : slg_(boost::log::keywords::channel = "Core") {}
public:
    src::severity_channel_logger<logging::trivial::severity_level, std::string>&  logger()
    {
        return slg_;
    }

    static LogSingleton* instance()
    {
        if (!instance_)
        {
            instance_ = new LogSingleton;
        }
        return instance_;
    }
};

LogSingleton* LogSingleton::instance_ = nullptr;

// 1. doesn't work
//#define BLOG(lvl)  BOOST_LOG_STREAM_WITH_PARAMS((LogSingleton::instance()->logger()), (::boost::log::keywords::severity = ::boost::log::trivial::lvl))

// access to logger via reference. Works if it is passed a ref to logger declared in main. Doesn't work if it is ref to logger in singleton
#define BLOG(lvl)  BOOST_LOG_STREAM_WITH_PARAMS((rlogger), (::boost::log::keywords::severity = ::boost::log::trivial::lvl))

int main(int argc, char **argv)
{
    logging::add_common_attributes();
    logging::trivial::severity_level level = logging::trivial::trace;
        auto formatter = expr::stream
        << "[" << expr::format_date_time<boost::posix_time::ptime>("TimeStamp", "%Y-%m-%dT%H:%M:%S.%f")
        << "] (" << logging::trivial::severity
        << "): " << expr::message;

    fs::path plog = fs::system_complete(fs::path(".."));
    if (!fs::exists(plog) || !fs::is_directory(plog))
        throw std::invalid_argument("Log directory doesn't exist, or path isn't a directory");
    plog /= "core.log";

    logging::add_file_log(logging::keywords::file_name = plog.string(),
        logging::keywords::open_mode = std::ios::app,
        logging::keywords::format = formatter)
        ->set_filter(logging::trivial::severity >= level &&    expr::attr< std::string >("Channel") == "Core");

    // this works with rlogger macro variant
    src::severity_channel_logger<logging::trivial::severity_level, std::string> logger(boost::log::keywords::channel = "Core");
    auto& rlogger = logger;

    // 2. this doesn't work, with same macro
    //auto& rlogger = LogSingleton::instance()->logger();

    // 3. just creating the singleton, before or after the creation of the local logger, stops logging from working
    //LogSingleton::instance();

    BLOG(info) << "Hello world";

    return 0;
}

如目前所述,此示例适用于本地记录器。标记为1的注释 - 这是使用单一记录器直接(失败)的宏的变体。同时注释掉本地记录器并启用对单例的引用将证明该问题。 (评论2)。标记为3的注释表明,仅创建单例记录器会导致日志记录通过本地记录器失败。

2 个答案:

答案 0 :(得分:2)

问题是由代码中LogSingleton的泄漏引起的。单例包含一个记录器,它可以防止日志记录核心和接收器被破坏。您所做的日志记录已正确处理并写入文件流但未刷新(即它最终在文件流缓冲区中)。通常,当流被销毁时会刷新流缓冲区(如果Boost.Log会在程序终止时销毁接收器时发生这种情况)或者在每个日志记录之后刷新,如果启用自动刷新(通过keywords::auto_flush = true参数到add_file_log函数调用。)

如果您将LogSingleton::instance_更改为std::unique_ptr,则可以修复此问题。

答案 1 :(得分:0)

首先确保您将所有模块与Boost.Log的共享库链接起来,而不是静态。在所有平台上的多模块应用程序中使用时,这是Boost.Log的requirement。另外,请确保使用影响Boost.Log的同一组配置宏构建所有模块。

接下来,如果您管理符号visibility,请确保从库中导出类型信息符号。这对异常类型和属性值类型尤为重要。如果您不熟悉符号可见性,则可能需要从导出所有符号开始,这可以通过构建没有任何-fvisibility*标志的模块来实现。

如果以上所有内容都没有帮助,则必须调试您的应用程序。特别是,请确保您设置的过滤器实际上是传递日志记录。您可能希望暂时删除过滤器以查看是否有帮助。如果这仍然没有帮助,请在调试器中逐步完成代码,以查看丢弃日志记录的位置。