2019-06-03 17:09:16 -04:00
|
|
|
// Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
|
2016-08-22 13:54:18 -04:00
|
|
|
// Distributed under the MIT License (http://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-07-14 09:21:53 -04:00
|
|
|
#include "spdlog/sinks/base_sink.h"
|
2019-06-25 18:21:40 -04:00
|
|
|
#include "spdlog/details/null_mutex.h"
|
2016-08-22 13:54:18 -04:00
|
|
|
|
|
|
|
#include <array>
|
|
|
|
#include <string>
|
|
|
|
#include <syslog.h>
|
|
|
|
|
2018-03-17 06:47:46 -04:00
|
|
|
namespace spdlog {
|
2018-04-20 06:20:19 -04:00
|
|
|
namespace sinks {
|
|
|
|
/**
|
|
|
|
* Sink that write to syslog using the `syscall()` library call.
|
|
|
|
*/
|
2018-07-14 09:21:53 -04:00
|
|
|
template<typename Mutex>
|
|
|
|
class syslog_sink : public base_sink<Mutex>
|
2018-04-20 06:20:19 -04:00
|
|
|
{
|
2019-06-18 17:52:38 -04:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
public:
|
2019-06-19 11:31:21 -04:00
|
|
|
syslog_sink(std::string ident, int syslog_option, int syslog_facility, bool enable_formatting)
|
|
|
|
: enable_formatting_{enable_formatting}
|
2019-07-05 03:45:37 -04:00
|
|
|
, syslog_levels_{/* spdlog::level::trace */ LOG_DEBUG,
|
|
|
|
/* spdlog::level::debug */ LOG_DEBUG,
|
|
|
|
/* spdlog::level::info */ LOG_INFO,
|
|
|
|
/* spdlog::level::warn */ LOG_WARNING,
|
|
|
|
/* spdlog::level::err */ LOG_ERR,
|
|
|
|
/* spdlog::level::critical */ LOG_CRIT,
|
|
|
|
/* spdlog::level::off */ LOG_INFO}
|
2019-06-19 11:31:21 -04:00
|
|
|
, ident_{std::move(ident)}
|
2018-04-20 06:20:19 -04:00
|
|
|
{
|
|
|
|
// set ident to be program name if empty
|
2018-06-10 15:59:17 -04:00
|
|
|
::openlog(ident_.empty() ? nullptr : ident_.c_str(), syslog_option, syslog_facility);
|
2018-04-20 06:20:19 -04:00
|
|
|
}
|
2018-02-24 17:56:56 -05:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
~syslog_sink() override
|
|
|
|
{
|
|
|
|
::closelog();
|
|
|
|
}
|
2016-08-22 13:54:18 -04:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
syslog_sink(const syslog_sink &) = delete;
|
|
|
|
syslog_sink &operator=(const syslog_sink &) = delete;
|
2016-08-22 13:54:18 -04:00
|
|
|
|
2018-07-14 09:21:53 -04:00
|
|
|
protected:
|
|
|
|
void sink_it_(const details::log_msg &msg) override
|
2018-04-20 06:20:19 -04:00
|
|
|
{
|
2019-06-18 17:52:38 -04:00
|
|
|
string_view_t payload;
|
|
|
|
|
2019-06-19 11:31:21 -04:00
|
|
|
if (enable_formatting_)
|
2019-06-18 17:52:38 -04:00
|
|
|
{
|
|
|
|
fmt::memory_buffer formatted;
|
2019-06-27 16:56:37 -04:00
|
|
|
base_sink<Mutex>::formatter_->format(msg, formatted);
|
2019-06-18 17:52:38 -04:00
|
|
|
payload = string_view_t(formatted.data(), formatted.size());
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
payload = msg.payload;
|
|
|
|
}
|
|
|
|
|
2019-07-09 19:19:16 -04:00
|
|
|
size_t length = payload.size();
|
|
|
|
// limit to max int
|
2019-07-09 19:42:47 -04:00
|
|
|
if (length > std::numeric_limits<int>::max())
|
2019-07-09 19:19:16 -04:00
|
|
|
{
|
|
|
|
length = std::numeric_limits<int>::max();
|
|
|
|
}
|
|
|
|
|
|
|
|
::syslog(syslog_prio_from_level(msg), "%.*s", static_cast<int>(length), payload.data());
|
2018-04-20 06:20:19 -04:00
|
|
|
}
|
2016-08-22 13:54:18 -04:00
|
|
|
|
2018-07-14 09:21:53 -04:00
|
|
|
void flush_() override {}
|
2019-06-18 17:52:38 -04:00
|
|
|
bool enable_formatting_ = false;
|
2016-08-22 13:54:18 -04:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
private:
|
2019-07-05 03:44:54 -04:00
|
|
|
std::array<int, 7> syslog_levels_;
|
2018-07-21 16:48:07 -04:00
|
|
|
// must store the ident because the man says openlog might use the pointer as
|
|
|
|
// is and not a string copy
|
2018-06-10 15:59:17 -04:00
|
|
|
const std::string ident_;
|
2016-08-22 13:54:18 -04:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
//
|
|
|
|
// Simply maps spdlog's log level to syslog priority level.
|
|
|
|
//
|
|
|
|
int syslog_prio_from_level(const details::log_msg &msg) const
|
|
|
|
{
|
2019-06-28 10:31:28 -04:00
|
|
|
return syslog_levels_.at(static_cast<int>(msg.level));
|
2018-04-20 06:20:19 -04:00
|
|
|
}
|
|
|
|
};
|
2018-07-14 09:21:53 -04:00
|
|
|
|
|
|
|
using syslog_sink_mt = syslog_sink<std::mutex>;
|
|
|
|
using syslog_sink_st = syslog_sink<details::null_mutex>;
|
2018-04-20 06:20:19 -04:00
|
|
|
} // namespace sinks
|
2018-04-19 19:57:05 -04:00
|
|
|
|
2018-04-20 06:20:19 -04:00
|
|
|
// Create and register a syslog logger
|
|
|
|
template<typename Factory = default_factory>
|
2019-06-19 11:31:21 -04:00
|
|
|
inline std::shared_ptr<logger> syslog_logger_mt(const std::string &logger_name, const std::string &syslog_ident = "", int syslog_option = 0,
|
|
|
|
int syslog_facility = LOG_USER, bool enable_formatting = false)
|
2018-07-14 09:21:53 -04:00
|
|
|
{
|
2019-06-18 17:52:38 -04:00
|
|
|
return Factory::template create<sinks::syslog_sink_mt>(logger_name, syslog_ident, syslog_option, syslog_facility, enable_formatting);
|
2018-07-14 09:21:53 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
template<typename Factory = default_factory>
|
2019-06-19 11:31:21 -04:00
|
|
|
inline std::shared_ptr<logger> syslog_logger_st(const std::string &logger_name, const std::string &syslog_ident = "", int syslog_option = 0,
|
|
|
|
int syslog_facility = LOG_USER, bool enable_formatting = false)
|
2018-04-20 06:20:19 -04:00
|
|
|
{
|
2019-06-18 17:52:38 -04:00
|
|
|
return Factory::template create<sinks::syslog_sink_st>(logger_name, syslog_ident, syslog_option, syslog_facility, enable_formatting);
|
2018-04-20 06:20:19 -04:00
|
|
|
}
|
2018-03-17 06:47:46 -04:00
|
|
|
} // namespace spdlog
|