重定向 C++ std::clog 到 Unix 上的 syslog

Question

我在 Unix 上开发一个 C++ 程序，该程序将消息发送到系统日志。

当前代码使用syslog系统调用，其工作方式类似于printf。

现在我更愿意使用流来实现此目的，通常是内置的 std::clog。但 clog 只是将输出重定向到 stderr，而不是 syslog，这对我来说毫无用处，因为我还使用 stderr 和 stdout 用于其他目的。

我在另一个答案中看到，使用以下命令将其重定向到文件非常容易rdbuf() 但我看不出有什么方法可以应用该方法来调用 syslog，因为 openlog 不会返回我可以用来在其上绑定流的文件处理程序。

还有另一种方法可以做到这一点吗？ （对于 UNIX 编程来说看起来非常基础）？

编辑：我正在寻找一种不使用外部库的解决方案。 @Chris 的提议可能是一个好的开始，但对于成为公认的答案来说仍然有点模糊。

编辑：使用 Boost.IOStreams 是可以的，因为我的项目已经使用了 Boost。

与外部库链接是可能的，但也是一个问题，因为它是 GPL 代码。依赖关系也是一种负担，因为它们可能与其他组件冲突，在我的 Linux 发行版上不可用，引入第三方错误等。如果这是唯一的解决方案，我可能会考虑完全避免流......（遗憾）。

Answer 1

我也需要像这样简单的东西，所以我只是把它放在一起：

log.h:

#include <streambuf>
#include <syslog.h>
enum LogPriority {
    kLogEmerg   = LOG_EMERG,   // system is unusable
    kLogAlert   = LOG_ALERT,   // action must be taken immediately
    kLogCrit    = LOG_CRIT,    // critical conditions
    kLogErr     = LOG_ERR,     // error conditions
    kLogWarning = LOG_WARNING, // warning conditions
    kLogNotice  = LOG_NOTICE,  // normal, but significant, condition
    kLogInfo    = LOG_INFO,    // informational message
    kLogDebug   = LOG_DEBUG    // debug-level message
};

std::ostream& operator<< (std::ostream& os, const LogPriority& log_priority);

class Log : public std::basic_streambuf<char, std::char_traits<char> > {
public:
    explicit Log(std::string ident, int facility);

protected:
    int sync();
    int overflow(int c);

private:
    friend std::ostream& operator<< (std::ostream& os, const LogPriority& log_priority);
    std::string buffer_;
    int facility_;
    int priority_;
    char ident_[50];
};

log.cc:

#include <cstring>
#include <ostream>
#include "log.h"

Log::Log(std::string ident, int facility) {
    facility_ = facility;
    priority_ = LOG_DEBUG;
    strncpy(ident_, ident.c_str(), sizeof(ident_));
    ident_[sizeof(ident_)-1] = '\0';

    openlog(ident_, LOG_PID, facility_);
}

int Log::sync() {
    if (buffer_.length()) {
        syslog(priority_, "%s", buffer_.c_str());
        buffer_.erase();
        priority_ = LOG_DEBUG; // default to debug for each message
    }
    return 0;
}

int Log::overflow(int c) {
    if (c != EOF) {
        buffer_ += static_cast<char>(c);
    } else {
        sync();
    }
    return c;
}

std::ostream& operator<< (std::ostream& os, const LogPriority& log_priority) {
    static_cast<Log *>(os.rdbuf())->priority_ = (int)log_priority;
    return os;
}

In main() Iinitial clog:

std::clog.rdbuf(new Log("foo", LOG_LOCAL0));

然后每当我想记录时，这很容易：

std::clog << kLogNotice << "test log message" << std::endl;

std::clog << "the default is debug level" << std::endl;

Answer 2

您可以定义一个调用 syslog 的 Streambuf。例如：

// Pseudo-code
class syslog_streambuf : public streambuf { 
private: 
    void internal_log(string& log) { 
        syslog(..., log, ...); 
    }
public: 
    int sputc ( char c ) { 
        internal_log(...); 
    }
    streamsize sputn ( const char * s, streamsize n ) { 
        internal_log(...); 
    } 
}

那么您只需编写以下内容即可重定向堵塞：

clog.rdbuf( new syslog_streambuf ); 

您可能还需要覆盖更多函数，这里有一个很好的 对 Streambuf API 的引用。

Answer 3

另一个版本部分受到食者的启发。它本身并不重定向 std::clog ，而是使用熟悉的流语法。

#ifndef SYSLOG_HPP
#define SYSLOG_HPP

#include <ostream>
#include <streambuf>
#include <string>

#include <syslog.h>

namespace log
{

enum level
{
    emergency = LOG_EMERG,
    alert     = LOG_ALERT,
    critical  = LOG_CRIT,
    error     = LOG_ERR,
    warning   = LOG_WARNING,
    notice    = LOG_NOTICE,
    info      = LOG_INFO,
    debug     = LOG_DEBUG,
};

enum type
{
    auth   = LOG_AUTH,
    cron   = LOG_CRON,
    daemon = LOG_DAEMON,
    local0 = LOG_LOCAL0,
    local1 = LOG_LOCAL1,
    local2 = LOG_LOCAL2,
    local3 = LOG_LOCAL3,
    local4 = LOG_LOCAL4,
    local5 = LOG_LOCAL5,
    local6 = LOG_LOCAL6,
    local7 = LOG_LOCAL7,
    print  = LOG_LPR,
    mail   = LOG_MAIL,
    news   = LOG_NEWS,
    user   = LOG_USER,
    uucp   = LOG_UUCP,
};

}

class syslog_stream;

class syslog_streambuf: public std::basic_streambuf<char>
{
public:
    explicit syslog_streambuf(const std::string& name, log::type type):
        std::basic_streambuf<char>()
    {
        openlog(name.size() ? name.data() : nullptr, LOG_PID, type);
    }
    ~syslog_streambuf() override { closelog(); }

protected:
    int_type overflow(int_type c = traits_type::eof()) override
    {
        if(traits_type::eq_int_type(c, traits_type::eof()))
            sync();
        else buffer += traits_type::to_char_type(c);

        return c;
    }

    int sync() override
    {
        if(buffer.size())
        {
            syslog(level, "%s", buffer.data());

            buffer.clear();
            level = ini_level;
        }
        return 0;
    }

    friend class syslog_stream;
    void set_level(log::level new_level) noexcept { level = new_level; }

private:
    static constexpr log::level ini_level = log::info;
    log::level level = ini_level;

    std::string buffer;
};

class syslog_stream: public std::basic_ostream<char>
{
public:
    explicit syslog_stream(const std::string& name = std::string(), log::type type = log::user):
        std::basic_ostream<char>(&streambuf),
        streambuf(name, type)
    { }

    syslog_stream& operator<<(log::level level) noexcept
    {
        streambuf.set_level(level);
        return (*this);
    }

private:
    syslog_streambuf streambuf;
};

#endif // SYSLOG_HPP

要使用它，您可以执行以下操作：

syslog_stream clog;

clog << "Hello, world!" << std::endl;
clog << log::emergency << "foo" << "bar" << "baz" << 42 << std::endl;

Answer 4

我设计了一个与上面显示的非常相似的 OStreamedLog 类，除了我的 OStreamedLog 对象设置为使用任意 ostringstream 对象，如 @Basilevs 建议的那样。

首先是Log的类定义，与上面提到的@eater和@Chris Kaminski非常相似。然后，我的 OStreamedLog 类定义，其中包含一个 Log 对象：

class OStreamedLog : public ostringstream
{
   public:
     OStreamedLog (const char* ident, int facility)
     {
          log = new Log (ident, facility);
          (static_cast<ostream*>(this))->rdbuf (log);
     }
   private:
     Log* log;
};

现在，当您需要记录时，只需调用：

OStreamedLog someLog ("MyOwnProgramThatNeedsLogging", LOG_LOCAL1);
someLog << "Log testing" << endl;
someLog << LOG_ERR << "some other error log" << endl;

当然，您可以将整个 Log 定义折叠到 OStreamedLog 类中，但您可能想在基类中执行其他操作日志对象并使用上面的包装器来区分不同类型的日志。例如，您可以拥有人类可读的诊断日志（以 ASCII 文本形式发送）、二进制日志（用于稍后处理）或 TLS 流日志（例如发送到北向服务器）。