如何为 boost::log 控制台输出添加颜色编码？答案

【问题标题】：How to add color coding to boost::log console output?如何为 boost::log 控制台输出添加颜色编码？
【发布时间】：2016-11-13 13:12:31
【问题描述】：

我正在尝试为 linux 下的 boost::log 添加彩色日志输出。我读了the following 并尝试了这个：

#define MY_LOG_ERROR() BOOST_LOG_TRIVIAL(error) << "\033[1;31"

MY_LOG_ERROR() << "This is an error log."

但它给了我以下结果：

[2016-07-11 17:23:16.328435] [0x00007f15f03d6780] [错误] [1;31这是错误日志。

如何正确添加彩色日志输出到 boost::log？

【问题讨论】：

你用什么终端？他们多次声明终端必须支持这些颜色代码......
您错过了代码序列中的尾随“m”。

标签： c++ logging boost boost-log boost-logging

【解决方案1】：

使用 Boost.Log 自定义输出的正确方法是使用 formatters。要设置格式化程序，您必须按照here 所述设置接收器，但您可以继续使用BOOST_LOG_TRIVIAL 宏来生成日志记录。

格式化程序的好处是您可以访问格式化程序中的日志记录属性，例如严重性级别。例如，您可以使用严重级别来选择控制台上格式化日志记录的颜色。

void coloring_formatter(
    logging::record_view const& rec, logging::formatting_ostream& strm)
{
    auto severity = rec[logging::trivial::severity];
    if (severity)
    {
        // Set the color
        switch (severity.get())
        {
        case logging::trivial::severity::info:
            strm << "\033[32m";
            break;
        case logging::trivial::severity::warning:
            strm << "\033[33m";
            break;
        case logging::trivial::severity::error:
        case logging::trivial::severity::fatal:
            strm << "\033[31m";
            break;
        default:
            break;
        }
    }

    // Format the message here...
    strm << rec[logging::expressions::smessage];

    if (severity)
    {
        // Restore the default color
        strm << "\033[0m";
    }
}

sink->set_formatter(&coloring_formatter);

【讨论】：

如何在上述代码的日志消息格式中添加TimeStamp和ThreadID？我希望结果类似于默认的普通日志记录格式。当我使用日志记录到文件时，我只写keywords::format = "[%TimeStamp%] [%ThreadID%] [%Severity%]: %Message%"。
我刚刚将上述评论发布为new question。

【解决方案2】：

我最近用一个简单的自定义接收器后端完成了这项工作

colored_console_sink.h

#pragma once
#include <boost/log/sinks/basic_sink_backend.hpp>

class coloured_console_sink : public boost::log::sinks::basic_formatted_sink_backend<char, boost::log::sinks::synchronized_feeding>
{
public:
    static void consume(boost::log::record_view const& rec, string_type const& formatted_string);
};

colored_console_sink.cpp

#include "coloured_console_sink.h"
#include <iostream>
#include <windows.h>
#include <boost/log/trivial.hpp>
#include <boost/log/attributes/value_extraction.hpp>
#include <boost/log/attributes/attribute_value.hpp>

WORD get_colour(boost::log::trivial::severity_level level)
{
    switch (level)
    {
        case boost::log::trivial::trace: return 0x08;
        case boost::log::trivial::debug: return 0x07;
        case boost::log::trivial::info: return 0x0F;
        case boost::log::trivial::warning: return 0x0D;
        case boost::log::trivial::error: return 0x0E;
        case boost::log::trivial::fatal: return 0x0C;
        default: return 0x0F;
    }
}

void coloured_console_sink::consume(boost::log::record_view const& rec, string_type const& formatted_string)
{
    auto level = rec.attribute_values()["Severity"].extract<boost::log::trivial::severity_level>();
    auto hstdout = GetStdHandle(STD_OUTPUT_HANDLE);

    CONSOLE_SCREEN_BUFFER_INFO csbi;
    GetConsoleScreenBufferInfo(hstdout, &csbi);

    SetConsoleTextAttribute(hstdout, get_colour(level.get()));
    std::cout << formatted_string << std::endl;
    SetConsoleTextAttribute(hstdout, csbi.wAttributes);
}

用法

typedef boost::log::sinks::synchronous_sink<coloured_console_sink> coloured_console_sink_t;
auto coloured_console_sink = boost::make_shared<coloured_console_sink_t>();

boost::log::core::get()->add_sink(coloured_console_sink);

【讨论】：