Журнал повышения для печати имени файла исходного кода и номера строки

Я использую Boost (1.55.0), вход в мой 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;
}

13

Решение

Как 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
12

Другие решения

Как указал user2943014, при использовании областей виден номер строки, в которой вы открыли эту область, а не номер строки, в которую вы отправили сообщение журнала, используя 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__);

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

4

определять

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,

1