Boost log для печати имени файла с исходным кодом и номера строки

Я использую Boost (1.55.0) Logging в моем приложении C ++. Мне удалось создать журнал этого формата

[2014-Jul-15 10:47:26.137959]: <debug>  A regular message

Я хочу иметь возможность добавлять имя исходного файла и номер строки, в которой создается журнал.

[2014-Jul-15 10:47:26.137959]: <debug> [filename:line_no] A regular message

пример:

[2014-Jul-15 10:47:26.137959]: <debug> [helloworld.cpp : 12] A regular message

Исходный код:

#include <boost/log/core.hpp>
#include <boost/log/trivial.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/sinks/text_file_backend.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/sources/severity_logger.hpp>
#include <boost/log/sources/record_ostream.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/support/date_time.hpp>
#include <boost/log/attributes/attribute.hpp>
#include <boost/log/attributes/attribute_cast.hpp>
#include <boost/log/attributes/attribute_value.hpp>
#include <boost/make_shared.hpp>
#include <boost/property_tree/ptree.hpp>

namespace logging = boost::log;
namespace src = boost::log::sources;
namespace sinks = boost::log::sinks;
namespace keywords = boost::log::keywords;

void init()
{
    logging::add_file_log
    (
        keywords::file_name = "sample_%N.log",                                        /*< file name pattern >*/
        keywords::rotation_size = 10*1024*1204,                                 /*< rotate files every 10 MiB... >*/
        keywords::time_based_rotation = sinks::file::rotation_at_time_point(0, 0, 0), /*< ...or at midnight >*/
        keywords::format =
        (
            boost::log::expressions::stream
                << boost::log::expressions::format_date_time< boost::posix_time::ptime >("TimeStamp", "%Y-%m-%d_%H:%M:%S.%f")
                << ": <" << boost::log::trivial::severity << "> "
                << boost::log::expressions::smessage
        )
    );
}

int main(int, char*[])
{
    init();
    logging::add_common_attributes();

    using namespace logging::trivial;
    src::severity_logger< severity_level > lg;

    BOOST_LOG_SEV(lg, debug) << "A regular message";
    return 0;
}

person Pritesh Acharya    schedule 15.07.2014    source источник
comment
Возможный дубликат Boost.Log: имя файла поддержки и номер строки   -  person graywolf    schedule 13.02.2017
comment
См. Также stackoverflow.com/questions/22095667/   -  person Jason Harrison    schedule 27.11.2018


Ответы (4)


Я бы посоветовал использовать функцию boost::log::add_value().

Определять:

#define LOG_LOCATION(LEVEL, MSG)      \
  BOOST_LOG_SEV(logger::get(), LEVEL)     \
    << boost::log::add_value("Line", __LINE__)          \
    << boost::log::add_value("File", __FILE__)          \
    << boost::log::add_value("Function", __FUNCTION__) << MSG

И тогда вы можете отформатировать его следующим образом:

boost::log::add_common_attributes();

boost::log::register_simple_filter_factory<boost::log::trivial::severity_level, char>("Severity");
boost::log::register_simple_formatter_factory<boost::log::trivial::severity_level, char>("Severity");

auto syslog_format(
    boost::log::expressions::stream <<
        "["   << boost::log::expressions::format_date_time< boost::posix_time::ptime >("TimeStamp", "%Y-%m-%d %H:%M:%S") <<
        "] [" << boost::log::expressions::attr<boost::log::attributes::current_thread_id::value_type>("ThreadID") << 
        "] [" << std::left << std::setw(7) << std::setfill(' ') << boost::log::trivial::severity <<
        "] "  << boost::log::expressions::smessage <<
        " ("  << boost::log::expressions::attr<std::string>("Filename") <<
        ":"   << boost::log::expressions::attr<int>("Line") <<
        ":"   << boost::log::expressions::attr<std::string>("Function") <<
        ")"
);

boost::log::add_file_log(
    boost::log::keywords::file_name  = "sys_%d_%m_%Y.%N.log",
    boost::log::keywords::format = syslog_format
);

Нет необходимости добавлять глобальные атрибуты, и вы можете легко отформатировать его, как показано выше. Я считаю, что это хороший компромисс между другими решениями и грубым __FILE__ __LINE__ подходом.

Полный пример здесь.

person mattdibi    schedule 13.02.2019
comment
Я знаю, что это старый поток, но для тех, кто пришел сюда из поиска, я обнаружил (как и другие), что решение Гильермо Руиса не было потокобезопасным, но это, похоже, (с использованием logger_mt и т. Д.), И, похоже, много проще. - person bevis; 13.09.2019

Как отметил Horus, вы можете использовать атрибуты для регистрации номеров файлов и строк. Однако лучше избегать использования макросов с несколькими операторами, чтобы избежать проблем с такими выражениями:

if (something)
   LOG_FILE_LINE(debug) << "It's true"; // Only the first statement is conditional!

Вы можете лучше создать макрос, который использует базовое поведение библиотеки Boost Log. Например, BOOST_LOG_SEV:

#define BOOST_LOG_SEV(logger, lvl) BOOST_LOG_STREAM_SEV(logger, lvl)
#define BOOST_LOG_STREAM_SEV(logger, lvl)\
    BOOST_LOG_STREAM_WITH_PARAMS((logger), (::boost::log::keywords::severity = (lvl)))

Используя BOOST_LOG_STREAM_WITH_PARAMS, вы можете установить и получить больше атрибутов, например:

// New macro that includes severity, filename and line number
#define CUSTOM_LOG(logger, sev) \
   BOOST_LOG_STREAM_WITH_PARAMS( \
      (logger), \
         (set_get_attrib("File", path_to_filename(__FILE__))) \
         (set_get_attrib("Line", __LINE__)) \
         (::boost::log::keywords::severity = (boost::log::trivial::sev)) \
   )

// Set attribute and return the new value
template<typename ValueType>
ValueType set_get_attrib(const char* name, ValueType value) {
   auto attr = logging::attribute_cast<attrs::mutable_constant<ValueType>>(logging::core::get()->get_thread_attributes()[name]);
   attr.set(value);
   return attr.get();
}

// Convert file path to only the filename
std::string path_to_filename(std::string path) {
   return path.substr(path.find_last_of("/\\")+1);
}

Полный исходный код:

#include <boost/log/trivial.hpp>
#include <boost/log/sources/severity_logger.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/attributes/mutable_constant.hpp>
#include <boost/date_time/posix_time/posix_time_types.hpp>
#include <boost/log/support/date_time.hpp>
#include <boost/log/attributes/mutable_constant.hpp>

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

// New macro that includes severity, filename and line number
#define CUSTOM_LOG(logger, sev) \
   BOOST_LOG_STREAM_WITH_PARAMS( \
      (logger), \
         (set_get_attrib("File", path_to_filename(__FILE__))) \
         (set_get_attrib("Line", __LINE__)) \
         (::boost::log::keywords::severity = (boost::log::trivial::sev)) \
   )

// Set attribute and return the new value
template<typename ValueType>
ValueType set_get_attrib(const char* name, ValueType value) {
   auto attr = logging::attribute_cast<attrs::mutable_constant<ValueType>>(logging::core::get()->get_thread_attributes()[name]);
   attr.set(value);
   return attr.get();
}

// Convert file path to only the filename
std::string path_to_filename(std::string path) {
   return path.substr(path.find_last_of("/\\")+1);
}

void init() {
   // New attributes that hold filename and line number
   logging::core::get()->add_thread_attribute("File", attrs::mutable_constant<std::string>(""));
   logging::core::get()->add_thread_attribute("Line", attrs::mutable_constant<int>(0));

   logging::add_file_log (
    keywords::file_name = "sample.log",
    keywords::format = (
     expr::stream
      << expr::format_date_time<boost::posix_time::ptime>("TimeStamp", "%Y-%m-%d_%H:%M:%S.%f")
      << ": <" << boost::log::trivial::severity << "> "
      << '['   << expr::attr<std::string>("File")
               << ':' << expr::attr<int>("Line") << "] "
      << expr::smessage
    )
   );
   logging::add_common_attributes();
}

int main(int argc, char* argv[]) {
   init();
   src::severity_logger<logging::trivial::severity_level> lg;

   CUSTOM_LOG(lg, debug) << "A regular message";
   return 0;
}

Это сгенерирует такой журнал:

2015-10-15_15:25:12.743153: <debug> [main.cpp:61] A regular message
person Guillermo Ruiz    schedule 15.10.2015
comment
+1. Посмотрите, как это реализовано - он должен работать быстрее, если вы определите тип атрибута как mutable_constant<boost::log::string_literal> и назначите его с помощью boost::log::string_literal(__FILE__) и т. Д., Поскольку он перестанет выделять / копировать строки в каждой строке журнала. - person bobah; 03.09.2016
comment
Хорошая точка зрения. Однако __LINE__ является целочисленной константой, и __FILE__ используется для получения подстроки в этом примере. boost::log::string_literal строится из константы массива, например char value[N]. - person Guillermo Ruiz; 12.10.2016
comment
@ Nature.Li указал, что код не является потокобезопасным. Я изменил глобальные атрибуты для атрибутов потоков в коде, но я не тестировал несколько потоков. - person Guillermo Ruiz; 12.10.2016
comment
@GuillermoRuiz Привет. Не могли бы вы поделиться потокобезопасным кодом? У меня также есть проблемы с потоками. - person unnamed; 07.11.2016
comment
Это работает в многопоточном коде? Я получаю несовместимые номера строк с этим решением - person Pranav; 30.12.2016
comment
Проблема с потоком не связана с add_thread_attribute или add_global_attribute, поскольку это действие является действием init, поэтому оно обычно вызывается в основном потоке. вызов add_thread_attribute в init проблематичен, это означает, что этот атрибут доступен только для основного потока. Если вы хотите, чтобы эта работа работала одновременно, вручную добавьте блокировку для защиты logging :: core :: get () - ›get_global_attributes (), он вернет объект attribute_set, который принадлежит ядру ведения журнала, который не может использоваться многопоточным без блокировки - person jean; 05.01.2017
comment
stackoverflow.com/a/31160870/781743 предоставляет более приятное и имхо поточно-ориентированное решение - person graywolf; 10.02.2017

Как указал user2943014, использование scopes печатает номер строки, в которой вы открыли эту область, а не номер строки, в которой вы отправили сообщение журнала, используя BOOST_LOG_SEV.

Вы можете использовать атрибуты для регистрации номеров строк и т. Д. В том месте, где вы фактически вошли.

Зарегистрируйте глобальные атрибуты в своей функции инициализации ведения журнала:

using namespace boost::log;
core::get()->add_global_attribute("Line", attributes::mutable_constant<int>(5));
core::get()->add_global_attribute("File", attributes::mutable_constant<std::string>(""));
core::get()->add_global_attribute("Function", attributes::mutable_constant<std::string>(""));

Установка этих атрибутов в макросе ведения журнала:

#define logInfo(methodname, message)                          \
  LOG_LOCATION;                                               \
  BOOST_LOG_SEV(_log, boost::log::trivial::severity_level::trace) << message

#define LOG_LOCATION                            \
  boost::log::attribute_cast<boost::log::attributes::mutable_constant<int>>(boost::log::core::get()->get_global_attributes()["Line"]).set(__LINE__); \
  boost::log::attribute_cast<boost::log::attributes::mutable_constant<std::string>>(boost::log::core::get()->get_global_attributes()["File"]).set(__FILE__); \
  boost::log::attribute_cast<boost::log::attributes::mutable_constant<std::string>>(boost::log::core::get()->get_global_attributes()["Function"]).set(__func__);

Не совсем красиво, но это работает, и это был долгий путь для меня. Жаль, что Boost не предлагает эту функцию из коробки.

person Horus    schedule 25.08.2015
comment
Мне нравится. Попробую это когда-нибудь - person Pritesh Acharya; 25.08.2015

Определять

namespace attrs = boost::logging::attributes;
namespace expr = boost::logging::expressions;

Добавлять

<< expr::format_named_scope("Scope", keywords::format = "[%f:%l]")

к вашему keywords::format = (...) в init.

Затем добавьте

logging::core::get()->add_global_attribute("Scope", attrs::named_scope());

после add_common_attributes() в main.

Затем прямо перед строкой BOOST_LOG_SEV добавьте BOOST_LOG_NAMED_SCOPE("whatever").

BOOST_LOG_NAMED_SCOPE("whatever") создает «область действия» с именем «что угодно». Область видимости реализуется неиспользуемой переменной, которая содержит имя области, файл и строку, в которой была определена область.

Строка format_named_scope указывает, как область видимости должна быть отформатирована в строке журнала. % f - это файл,% l - это строка, а% n - это имя области.

Обратите внимание, что строка файла, которая появляется в записи журнала, является строкой, где появляется макрос BOOST_LOG_NAMED_SCOPE, а не строкой макроса BOOST_LOG_SEV.

Я не знаю простого метода записи файла и строки без использования BOOST_LOG_NAMED_SCOPE.

person srn    schedule 11.08.2014