2016-08-22 15:09:23 -04:00
|
|
|
//
|
|
|
|
// Copyright(c) 2015 Gabi Melman.
|
|
|
|
// Distributed under the MIT License (http://opensource.org/licenses/MIT)
|
|
|
|
//
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-07-21 16:48:07 -04:00
|
|
|
// Very fast asynchronous logger (millions of logs per second on an average
|
|
|
|
// desktop)
|
|
|
|
// Uses pre allocated lockfree queue for maximum throughput even under large
|
|
|
|
// number of threads.
|
2016-08-22 15:09:23 -04:00
|
|
|
// Creates a single back thread to pop messages from the queue and log them.
|
|
|
|
//
|
|
|
|
// Upon each log write the logger:
|
|
|
|
// 1. Checks if its log level is enough to log the message
|
2018-07-21 16:48:07 -04:00
|
|
|
// 2. Push a new copy of the message to a queue (or block the caller until
|
|
|
|
// space is available in the queue)
|
2016-08-22 15:09:23 -04:00
|
|
|
// 3. will throw spdlog_ex upon log exceptions
|
2018-07-21 16:48:07 -04:00
|
|
|
// Upon destruction, logs all remaining messages in the queue before
|
|
|
|
// destructing..
|
2016-08-22 15:09:23 -04:00
|
|
|
|
2019-04-26 08:11:01 -04:00
|
|
|
#include "spdlog/logger.h"
|
2018-04-13 21:16:05 -04:00
|
|
|
|
2018-03-09 08:26:33 -05:00
|
|
|
namespace spdlog {
|
2018-07-20 16:20:48 -04:00
|
|
|
|
|
|
|
// Async overflow policy - block by default.
|
|
|
|
enum class async_overflow_policy
|
|
|
|
{
|
|
|
|
block, // Block until message can be enqueued
|
2018-07-21 16:48:07 -04:00
|
|
|
overrun_oldest // Discard oldest message in the queue if full when trying to
|
|
|
|
// add new item.
|
2018-07-20 16:20:48 -04:00
|
|
|
};
|
|
|
|
|
2018-03-09 08:26:33 -05:00
|
|
|
namespace details {
|
2018-04-13 20:34:57 -04:00
|
|
|
class thread_pool;
|
2016-08-22 15:09:23 -04:00
|
|
|
}
|
|
|
|
|
2018-09-26 07:33:37 -04:00
|
|
|
class async_logger final : public std::enable_shared_from_this<async_logger>, public logger
|
2016-08-22 15:09:23 -04:00
|
|
|
{
|
2018-04-13 20:34:57 -04:00
|
|
|
friend class details::thread_pool;
|
|
|
|
|
2016-08-22 15:09:23 -04:00
|
|
|
public:
|
2018-07-14 09:21:53 -04:00
|
|
|
template<typename It>
|
2018-10-03 19:06:39 -04:00
|
|
|
async_logger(std::string logger_name, It begin, It end, std::weak_ptr<details::thread_pool> tp,
|
2018-07-07 17:53:50 -04:00
|
|
|
async_overflow_policy overflow_policy = async_overflow_policy::block);
|
2016-08-22 15:09:23 -04:00
|
|
|
|
2018-08-13 03:30:02 -04:00
|
|
|
async_logger(std::string logger_name, sinks_init_list sinks_list, std::weak_ptr<details::thread_pool> tp,
|
2018-07-07 17:53:50 -04:00
|
|
|
async_overflow_policy overflow_policy = async_overflow_policy::block);
|
2016-08-22 15:09:23 -04:00
|
|
|
|
2018-07-19 08:00:05 -04:00
|
|
|
async_logger(std::string logger_name, sink_ptr single_sink, std::weak_ptr<details::thread_pool> tp,
|
2018-07-07 17:53:50 -04:00
|
|
|
async_overflow_policy overflow_policy = async_overflow_policy::block);
|
2017-03-27 18:54:33 -04:00
|
|
|
|
2018-08-25 10:35:20 -04:00
|
|
|
std::shared_ptr<logger> clone(std::string new_name) override;
|
|
|
|
|
2016-08-22 15:09:23 -04:00
|
|
|
protected:
|
2018-10-05 07:23:37 -04:00
|
|
|
void sink_it_(details::log_msg &msg) override;
|
2018-06-10 15:59:17 -04:00
|
|
|
void flush_() override;
|
2018-04-13 20:34:57 -04:00
|
|
|
|
2018-09-26 17:47:09 -04:00
|
|
|
void backend_log_(const details::log_msg &incoming_log_msg);
|
2018-06-10 15:59:17 -04:00
|
|
|
void backend_flush_();
|
2016-08-22 15:09:23 -04:00
|
|
|
|
|
|
|
private:
|
2018-06-10 15:59:17 -04:00
|
|
|
std::weak_ptr<details::thread_pool> thread_pool_;
|
|
|
|
async_overflow_policy overflow_policy_;
|
2016-08-22 15:09:23 -04:00
|
|
|
};
|
2018-03-09 08:26:33 -05:00
|
|
|
} // namespace spdlog
|
2016-08-22 15:09:23 -04:00
|
|
|
|
2019-04-26 08:11:01 -04:00
|
|
|
#ifdef SPDLOG_HEADER_ONLY
|
2019-04-26 19:33:33 -04:00
|
|
|
#include "spdlog/impl/async_logger.cpp"
|
2019-04-26 08:11:01 -04:00
|
|
|
#endif // SPDLOG_HEADER_ONLY
|