4

我有一个广泛使用 boost log 2.0 的应用程序。现在我想为该应用程序设置一些默认标志，例如std::setprecision(std::numeric_limits<double>::digits10 + 1),std::scientific和std::left. 但是我该怎么做呢？一种方法是在我的主要功能的最开始创建一个记录器并创建一个虚拟日志消息。这将永久设置所需的标志。但是没有更好的方法来做到这一点吗？

编辑回复：“OP 应该显示实际代码。”

我有一个名为 L 的全局 Logging 单例：

class L{
public:
  enum severity_level
  {
      dddebug,
      ddebug,
      debug,
      control,
      iiinfo,
      iinfo,
      info,
      result,
      warning,
      error,
      critical
  };

  typedef boost::log::sources::severity_channel_logger<
      severity_level, // the type of the severity level
      std::string // the type of the channel name
  > logger_t;
  typedef boost::log::sinks::synchronous_sink< boost::log::sinks::text_ostream_backend > text_sink;
  boost::shared_ptr< text_sink > sink_;

  static L& get();
  static boost::shared_ptr<text_sink> sink();
  static double t0();
  static double tElapsed();
private:
  L();
  double t0_p;
  static std::string tElapsedFormat();

  L(const L&) = delete;
  void operator=(const L&) = delete;
};

它提供了一个日志接收器、严重性级别，并利用 MPI 方法在 MPI 节点之间进行同步计时。类成员的实现如下：

#include "log.h"

#include <iomanip>
#include <limits>
#include <fstream>
#include <boost/log/attributes/function.hpp>
#include <boost/smart_ptr/shared_ptr.hpp>
#include <boost/smart_ptr/make_shared_object.hpp>
#include <boost/log/core.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/sources/severity_channel_logger.hpp>
#include <boost/log/sinks/sync_frontend.hpp>
#include <boost/log/sinks/text_ostream_backend.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>


namespace logging = boost::log;
namespace src = boost::log::sources;
namespace expr = boost::log::expressions;
namespace sinks = boost::log::sinks;
namespace attrs = boost::log::attributes;
namespace keywords = boost::log::keywords;

#include "mpiwrap.h"
#include <mpi.h>

BOOST_LOG_ATTRIBUTE_KEYWORD(t, "Time", std::string)
BOOST_LOG_ATTRIBUTE_KEYWORD(rank, "Rank", int)
BOOST_LOG_ATTRIBUTE_KEYWORD(channel, "Channel", std::string)
BOOST_LOG_ATTRIBUTE_KEYWORD(severity, "Severity", L::severity_level)

L::L():
  sink_(boost::make_shared< text_sink >()),
  t0_p(MPI_Wtime())
{

  sink_->locked_backend()->add_stream(
    boost::make_shared< std::ofstream >("log." + std::to_string(MpiWrap::getRank())));

  sink_->set_formatter
  (
    expr::stream
      << "< "
      << t << " "
      << "[p:" << rank << "] "
      << "[c:" << channel << "] "
      << "[s:" << severity << "] "
      << expr::smessage
  );

  logging::core::get()->add_sink(sink_);

  logging::core::get()->set_filter(

       (channel == "ChannelName1" && severity >= dddebug)
    || (channel == "ChannelName2" && severity >= info)
    || (channel == "ChannelName3" && severity >= result)

  );

  // Add attributes
  logging::core::get()->add_global_attribute("Time", attrs::make_function(&tElapsedFormat));
  logging::core::get()->add_global_attribute("Rank", attrs::constant<int>(MpiWrap::getRank()));
}

L& L::get(){
  static L instance;
  return instance;
}

boost::shared_ptr<L::text_sink> L::sink(){
  return get().sink_;
}

double L::t0(){
  return get().t0_p;
}

double L::tElapsed(){
  return MPI_Wtime() - t0();
}

std::string L::tElapsedFormat(){
  std::stringstream ss;
  const int prec = std::numeric_limits<double>::digits10;
  ss << std::setw(prec + 2 + 6) << std::left << std::setprecision(prec) << tElapsed();
  return ss.str();
}

std::ostream& operator<< (std::ostream& strm, L::severity_level level)
{
    static const char* strings[] =
    {
        "DBG3",
        "DBG2",
        "DBG1",
        "CTRL",
        "INF3",
        "INF2",
        "INF1",
        "RSLT",
        "WARN",
        "ERRR",
        "CRIT"
    };

    if (static_cast< std::size_t >(level) < sizeof(strings) / sizeof(*strings))
        strm << strings[level];
    else
        strm << static_cast< int >(level);

    return strm;
}

现在使用：我的类通常有一个静态logger_t（typedef for boost::log::sources::severity_channel_logger<severity_level, std::string>）成员

class A {
public:
    logger_t logger;
    //other stuff here
    void function_which_does_logging();
};

L::logger_t A::logger(boost::log::keywords::channel = "ClassA");

void A::function_which_does_logging(){
    //do non logging related stuff
    BOOST_LOG_SEV(logger, L::result) << "the error is: " << 0.1234567890;
    //do non logging related stuff
}

我目前对该问题的解决方案是在我的程序开头放置一个日志记录语句

int main(){
    L::logger_t logger(boost::log::keywords::channel = "init");
    BOOST_LOG_SEV(logger, L::critical) << "setting up logger" << std::scientific << std::setprecision(std::numeric_limits<double>::digits10 + 1);

    //do stuff
}
4

2 回答 2

5

@rhashimoto 很好地说明了您当前的解决方案将如何因多线程/并发日志记录操作而崩溃。我觉得最好的解决方案是定义自己的日志记录宏来替换BOOST_LOG_SEV包含流修饰符的宏，如下所示：

#define LOG_SCIENTIFIC(logger, sev) (BOOST_LOG_SEV(logger, sev) << std::scientific)

可以将其用作将BOOST_LOG_SEV数字格式化为科学格式的替代品。但是，通过代码并用新的自定义宏替换每个日志记录操作可能会很痛苦。除了定义自己的宏，您还可以重新定义BOOST_LOG_SEV以按照您的意愿行事。boost/log/sources/severity_feature.hpp定义BOOST_LOG_SEV如下：

//! An equivalent to BOOST_LOG_STREAM_SEV(logger, lvl)
#define BOOST_LOG_SEV(logger, lvl) BOOST_LOG_STREAM_SEV(logger, lvl)

因为BOOST_LOG_STREAM_SEV仍然是公共 boost API 的一部分，你应该能够BOOST_LOG_SEV像这样安全地重新定义：

#define BOOST_LOG_SEV(logger, lvl) (BOOST_LOG_STREAM_SEV(logger, lvl) << std::scientific)

只要在包含 boost 日志标头之后定义它，它就应该做你想做的事。但是，我建议使用具有自定义名称的宏，以便其他人清楚您的代码在做什么。

于 2014-04-28T01:57:18.870 回答
4

我不相信您当前的方法适用于所有情况，特别是如果您的代码是线程的。当您说单个记录格式标志可以修复多个记录器时，我感到很紧张，所以我查看了代码（record_ostream.hpp 和 record_ostream.cpp）。

Boost Log 使用对象池设计模式为带有辅助结构的记录器提供流格式化程序stream_provider。的实现使用线程本地存储（当支持线程时）为每个线程stream_provider使用单独的实例池。ostream在池中，ostream根据需要创建实例 - 如果一次只需要一个格式化程序，则只会创建一个。因此，如果您从单个线程进行日志记录并且您从未在记录其他内容的过程中记录某些内容，那么我认为您当前的解决方法将适用于当前的 Boost Log 实现。

线程如何失败应该很明显。这是一个简单的示例，说明这如何在单个线程中失败：

static double f(double x) {
   BOOST_LOG(my_logger::get()) << "called f with " << x;
   return x;
}

int main() {
   BOOST_LOG(my_logger::get()) << std::scientific << "format flag";
   BOOST_LOG(my_logger::get()) << "top level " << f(0.01);
   return 0;
}

产生：

[2014-04-27 14:16:39.832008] [0x000007fff7a1c631] [info]    format flag
[2014-04-27 14:16:39.832616] [0x000007fff7a1c631] [info]    called f with 0.01
[2014-04-27 14:16:39.832630] [0x000007fff7a1c631] [info]    top level 1.000000e-02

请注意，顶级日志条目（在第三行）的格式正确，而函数日志条目（在第二行）则没有。这是因为在调用函数时正在使用配置的流，因此创建并使用了单独的流。

我认为@WilliamKunkel 定义您自己的日志记录宏的建议是我见过的处理此问题的最佳方式。但是，如果你真的想使用 Boost 宏，这个 hack 在 Boost 1.55 上对我有用：

#include <iomanip>

#define BOOST_LOG_DYN_LINK
#include <boost/log/sources/global_logger_storage.hpp>
#include <boost/log/sources/logger.hpp>
#include <boost/log/sources/record_ostream.hpp>

typedef boost::log::sources::logger logger_t;
BOOST_LOG_INLINE_GLOBAL_LOGGER_DEFAULT(my_logger, logger_t)

namespace boost {
   namespace log {
      namespace aux {
         template<>
         BOOST_FORCEINLINE record_pump<logger_t> make_record_pump(logger_t& lg, record& rec)
         {
            auto rp = record_pump<logger_t>(lg, rec);
            rp.stream() << std::scientific;
            return rp;
         }
      }
   }
}

int main() {
   BOOST_LOG(my_logger::get()) << "Logging number " << 0.01;
   return 0;
}

基本思想是专门化为宏提供流的模板函数。当它专门用于您正在使用的实际记录器类时，传递std::scientific标志的专门实现将优先于通用实现。

这是一个 hack，因为它取决于 Boost Log 的实现细节，并且不能保证从一个版本到另一个版本都可以工作。在我看来，定义自己的宏似乎是一种更好的方法。

我曾希望可以做一些事情，boost::log::basic_formatting_stream因为它的标题说：

虽然basic_formatting_ostream不是从 派生的std::basic_ostream，但用户不需要为其添加特殊的重载，operator<<因为默认情况下流将重用操作符 for std::basic_ostream。但是，如果某种类型在输出到日志时需要特殊格式，则可以定义operator<<for的特殊重载。basic_formatting_ostream

不幸的是，这看起来只适用于类类型而不是原始类型，operator<<因为所有原始类型都有成员函数实现。

于 2014-04-27T18:16:47.133 回答