提升日志和严重性/本地属性
Boost log and severity / local attributes
我是Boost日志的新手。 我有一些简单的东西在工作,但我坚持使用宏来轻松指定文件名和行号。 这看起来太难了,我想我错过了一些东西。
我写这个是为了在最后用演示日志初始化日志记录。 请注意,我正在登录到控制台和旋转文件。
logging::add_console_log(std::clog, keywords::format = "%TimeStamp%: %_%",
keywords::auto_flush = true);
typedef sinks::synchronous_sink<sinks::text_file_backend> file_sink;
shared_ptr<file_sink> sink(new file_sink(
keywords::file_name = "%Y%m%d_%H%M%S_%5N.log",
keywords::rotation_size = 16384, keywords::auto_flush = true));
sink->locked_backend()->set_file_collector(sinks::file::make_collector(
keywords::target = "logs",
keywords::max_size = 16 * 1024 * 1024,
keywords::min_free_space = 100 * 1024 * 1024));
sink->locked_backend()->scan_for_files();
sink->set_formatter(expr::stream
<< expr::attr<boost::posix_time::ptime>("TimeStamp")
<< " " << logging::trivial::severity << "["
<< expr::attr<string>("FileName") << ":"
<< expr::attr<unsigned int>("LineNumber") << "] "
<< expr::smessage);
logging::core::get()->add_sink(sink);
logging::add_common_attributes();
logging::core::get()->add_global_attribute("TimeStamp",
attrs::local_clock());
src::severity_logger<logging::trivial::severity_level> slg;
lg.add_attribute("LineNumber", attrs::constant<unsigned int>(__LINE__));
lg.add_attribute("FileName", attrs::constant<string>(__FILE__));
for (unsigned int i = 0; i < 5; ++i) {
BOOST_LOG_SEV(slg, logging::trivial::info) << "Some log record";
}
现在我想制作一个宏,以便我可以添加文件和行号,并让它像 ostream 一样运行。 我希望能够做的是说
LOG(info) << "Hello, world!";
我写了以下内容,这不起作用,但它表达了我想要做的事情:
#define LOG(severity_level) LogMessage(__FILE__, __LINE__, severity_level)
// What's my return type?
auto LogMessage(const char* filename, const int line_number,
const enum SeverityLevel) {
src::severity_logger slg;
slg.add_attribute("LineNumber", attrs::constant<unsigned int>(__LINE__));
slg.add_attribute("FileName", attrs::constant<string>(__FILE__));
return BOOST_LOG_SEV(slg, severity_level); // NO
}
这里回答了一个类似的问题,我将重新讨论我的建议。
- 最简单的解决方案是定义您自己的日志记录宏,该宏将在消息前面加上源文件中的位置。例如:
#define LOG(lg, sev)
BOOST_LOG_SEV(lg, sev) << "[" << __FILE__ << ":" << __LINE__ << "]: "
现在,您可以在代码中的任何位置使用此宏,而不是BOOST_LOG_SEV
。此解决方案的缺点是不能将文件和行用作属性,因此日志格式是固定的。
- 使用流操纵器将文件名和行号附加为属性。同样,在宏中执行此操作更容易:
BOOST_LOG_ATTRIBUTE_KEYWORD(a_file, "File", std::string)
BOOST_LOG_ATTRIBUTE_KEYWORD(a_line, "Line", unsigned int)
#define LOG(lg, sev)
BOOST_LOG_SEV(lg, sev) << logging::add_value(a_file, __FILE__) << logging::add_value(a_line, __LINE__)
(有关关键字,请参阅此处。完成此操作后,您可以在格式化程序中使用这些属性:
sink->set_formatter(
expr::stream << "[" << a_file << ":" << a_line << "]: " << expr::message);
以这种方式添加的属性不能在过滤器中使用,如果这是一个问题,你可以......
- 使用作用域属性。同样,您可以定义一个宏来自动执行该过程:
#define LOG(lg, sev, strm)
do {
BOOST_LOG_SCOPED_LOGGER_ATTR(lg, a_file.get_name(), attrs::constant< tag::a_file::value_type >(__FILE__));
BOOST_LOG_SCOPED_LOGGER_ATTR(lg, a_line.get_name(), attrs::constant< tag::a_line::value_type >(__LINE__));
BOOST_LOG_SEV(lg, sev) strm;
} while (false)
请注意,在这种情况表达式作为参数传递给宏,因为我们需要将其注入到范围的中间。另请注意,此解决方案的性能可能不如其他两个解决方案。
在某些时候确实没有不涉及宏的解决方案,因为__FILE__
和__LINE__
都是在使用时展开的宏。我相信,这是您的代码的问题之一,您在LogMessage
函数中使用了宏。
这是因为无论如何都必须定义宏,这些宏应该是特定于用户的,Boost.Log 不提供开箱即用的此功能。
这个答案很大程度上归功于这些对话,特别是@guillermo-ruiz提出的解决方案。 我选择遵循吉列尔莫的建议,因为它最少地使用预处理器。 (当然,预处理器的某些使用是强制性的,因为我想要__FILE__
和__LINE__
。
为了向那些遵循更广泛的帮助而不仅仅是严格答案的人提供
一些评论:- 是的,Boost 日志没有提供开箱即用的功能,这很奇怪。
- 提升日志没有像我希望的那样进行那么多的错误检查。 特别是,如果定义时的属性名称与使用时的名称不匹配,则结果是没有描述性错误的段错误,而不是运行时错误(后跟中止或不中止)。
- 提升日志对于正确获取包含语句非常敏感。 没有一个包含来统治它们,缺少包含会导致错误消息提示编程错误,而实际上,它只是一个缺少的定义。
在文件log.cc
中,我这样写道:
Log::Log() {
try {
// The first thing we have to do to get using the library is
// to set up the logging sinks - i.e. where the logs will be written to.
logging::add_console_log(std::clog,
keywords::format = "%TimeStamp%: %_%",
keywords::auto_flush = true);
// Create a text file sink
typedef sinks::synchronous_sink<sinks::text_file_backend> file_sink;
shared_ptr<file_sink> sink(new file_sink(
// File name pattern.
keywords::file_name = "%Y%m%d_%H%M%S_%5N.log",
// Rotation size, in characters
keywords::rotation_size = 16384,
// Rotate daily if not more often. The time is arbitrary.
keywords::time_based_rotation =
sinks::file::rotation_at_time_point(4, 33, 17),
// Flush after write.
keywords::auto_flush = true));
// Set up where the rotated files will be stored.
sink->locked_backend()->set_file_collector(sinks::file::make_collector(
// Where to store rotated files.
keywords::target = "logs",
// Maximum total size of the stored files, in bytes.
keywords::max_size = 16 * 1024 * 1024,
// Minimum free space on the drive, in bytes.
keywords::min_free_space = 100 * 1024 * 1024));
// Upon restart, scan the target directory for files matching the
// file_name pattern.
sink->locked_backend()->scan_for_files();
boost::log::register_simple_formatter_factory<
logging::trivial::severity_level, char>("Severity");
sink->set_formatter(expr::stream
<< expr::attr<boost::posix_time::ptime>("TimeStamp")
<< " " << logging::trivial::severity << "["
<< expr::attr<string>("FileName") << ":"
<< expr::attr<unsigned int>("LineNumber") << "] "
<< expr::smessage);
// Add it to the core
logging::core::get()->add_sink(sink);
// Add some attributes too
logging::add_common_attributes();
logging::core::get()->add_global_attribute("TimeStamp",
attrs::local_clock());
logging::core::get()->add_global_attribute(
"LineNumber", attrs::mutable_constant<unsigned int>(5));
logging::core::get()->add_global_attribute(
"FileName", attrs::mutable_constant<string>(""));
src::severity_logger<logging::trivial::severity_level> slg;
slg.add_attribute("LineNumber",
attrs::constant<unsigned int>(__LINE__));
slg.add_attribute("FileName", attrs::constant<string>(__FILE__));
for (unsigned int i = 0; i < 2; ++i) {
BOOST_LOG_SEV(slg, logging::trivial::info) << "Testing log, #" << i;
}
} catch (std::exception& e) {
std::cerr << "Failed to establish logging: " << e.what() << std::endl;
throw LoggingInitException();
}
}
Log::~Log() { boost::log::core::get()->remove_all_sinks(); }
string PathToFilename(const string& path) {
string sub_path = path.substr(path.find_last_of("/\") + 1);
return sub_path;
}
在文件log.h
中,我这样写道:
// An exception if logging fails to initialize.
class LoggingInitException : public std::exception {};
/*
Class to set up logging as we want it in all services.
Instantiate a Log object near the beginning of main().
*/
class Log {
public:
Log();
~Log();
};
// Logging macro that includes severity, filename, and line number.
// Copied and modified from
// https://stackoverflow.com/questions/24750218/boost-log-to-print-source-code-file-name-and-line-number
// Set attribute and return the new value
template <typename ValueType>
ValueType SetGetAttrib(const char* name, ValueType value) {
auto attr = boost::log::attribute_cast<
boost::log::attributes::mutable_constant<ValueType>>(
boost::log::core::get()->get_global_attributes()[name]);
attr.set(value);
return attr.get();
}
// Convert file path to only the filename
std::string PathToFilename(const std::string& path);
// Shortcut to declare a log source. To insert in each function that will call
// the LOG macro.
#define LOGGABLE
boost::log::sources::severity_logger<boost::log::trivial::severity_level>
slg;
#define LOG(sev)
BOOST_LOG_STREAM_WITH_PARAMS(
(slg),
(SetGetAttrib("FileName", PathToFilename(__FILE__)))(
SetGetAttrib("LineNumber", (unsigned int)__LINE__))(
::boost::log::keywords::severity = (boost::log::trivial::sev)))
然后,要从文件foo.cc
记录,我这样做:
void MyFunction() {
LOGGABLE;
LOG(debug) << "I made it to MyFunction().";
}
int main(int argc, char *argv[]) {
Log log;
LOGGABLE;
LOG(info) << "Hey, I'm a message!";
MyFunction();
return 0;
}
还有一些狡辩仍然存在,但它们超出了这个SO问题/答案的范围:
- 为了使它更有用,我应该让日志比"日志"更具体,可能由调用标志和应用程序名称指导,无论我是否在生产环境中,等等。
- 我应该检查标准输出是否连接到终端,如果没有,请跳过登录到标准输出。 或者我应该提供一个标志来禁用它,至少在数据中心。
- 有时,神秘地,我得到一个名为(例如)
20160310_093628_00000.log
的顶级日志文件,而不是写入logs/
目录的文件。 我花了很长时间才意识到 boost 日志在那里写入,然后轮换到 logs/目录。 因此,如果程序崩溃,我最终会得到该级别的日志文件。
- 如何导出包含具有"std::unique_ptr"值的"std::map"属性的
- C++概念:如何使用'concept'检查模板化结构的属性?
- 子目录是否继承属性,例如add_definitions,include_directories和父Cmakelist.t
- 通过指向指针数组的指针访问子类的属性
- MSVC是否支持C++11样式的属性而不是__declspec
- QML:修改在不同QML文件(而非main.QML)中定义的子对象的属性
- 类的C++属性似乎已重新初始化
- Qt Quick-如何仅从c++代码与qml属性交互
- 用概念检查属性的类型
- C++如何将同一类的实例作为属性
- 按多个属性排序
- 主函数参数的属性
- "perf_event_attr"结构的"read_format"属性的选项到底是什么?
- C++删除未使用的类属性会导致 std::logic_error
- 无法使用 SWIG 在 Python 中实例化C++类(获取属性错误)
- 使用内存地址访问结构的属性值
- C++调用具有 *this 属性的单个帮助程序函数
- C++ 在堆栈中包含多态属性的类对象存储
- 提升::日志 - 使用严重性和自定义过滤器属性记录?要使用的宏
- 提升日志和严重性/本地属性