Перенаправить C ++ std :: clog в системный журнал на Unix

Question

Я работаю в Unix над программой на C ++, которая отправляет сообщения в системный журнал.

В текущем коде используется системный вызов syslog , который работает как printf.

Теперь я предпочел бы вместо этого использовать поток, обычно встроенный std :: 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;
}

В main() я инициализирую 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

Вы можете определить streambuf, который вызывает syslog. Например:

// 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 per se, но использует знакомый синтаксис потока.

#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, но вы можете захотеть сделать другие вещи в вашем базовом объекте Log и использовать обертки, как описано выше, для дифференциации различных типов журналов. Например, у вас могут быть читаемые человеком диагностические журналы (отправляемые в виде текста ASCII), двоичные журналы (для последующей обработки) или журнал потоковой передачи TLS (например, на северный сервер).