1 // 2 // Copyright(c) 2015 Gabi Melman. 3 // Distributed under the MIT License (http://opensource.org/licenses/MIT) 4 // 5 6 // spdlog main header file. 7 // see example.cpp for usage example 8 9 #pragma once 10 11 #include <spdlog/tweakme.h> 12 #include <spdlog/common.h> 13 #include <spdlog/logger.h> 14 15 #include <memory> 16 #include <functional> 17 #include <chrono> 18 #include <string> 19 20 namespace spdlog 21 { 22 23 // 24 // Return an existing logger or nullptr if a logger with such name doesn't exist. 25 // example: spdlog::get("my_logger")->info("hello {}", "world"); 26 // 27 std::shared_ptr<logger> get(const std::string& name); 28 29 30 // 31 // Set global formatting 32 // example: spdlog::set_pattern("%Y-%m-%d %H:%M:%S.%e %l : %v"); 33 // 34 void set_pattern(const std::string& format_string); 35 void set_formatter(formatter_ptr f); 36 37 // 38 // Set global logging level for 39 // 40 void set_level(level::level_enum log_level); 41 42 // 43 // Set global error handler 44 // 45 void set_error_handler(log_err_handler); 46 47 // 48 // Turn on async mode (off by default) and set the queue size for each async_logger. 49 // effective only for loggers created after this call. 50 // queue_size: size of queue (must be power of 2): 51 // Each logger will pre-allocate a dedicated queue with queue_size entries upon construction. 52 // 53 // async_overflow_policy (optional, block_retry by default): 54 // async_overflow_policy::block_retry - if queue is full, block until queue has room for the new log entry. 55 // async_overflow_policy::discard_log_msg - never block and discard any new messages when queue overflows. 56 // 57 // worker_warmup_cb (optional): 58 // callback function that will be called in worker thread upon start (can be used to init stuff like thread affinity) 59 // 60 // worker_teardown_cb (optional): 61 // callback function that will be called in worker thread upon exit 62 // 63 void set_async_mode(size_t queue_size, const async_overflow_policy overflow_policy = async_overflow_policy::block_retry, const std::function<void()>& worker_warmup_cb = nullptr, const std::chrono::milliseconds& flush_interval_ms = std::chrono::milliseconds::zero(), const std::function<void()>& worker_teardown_cb = nullptr); 64 65 // Turn off async mode 66 void set_sync_mode(); 67 68 69 // 70 // Create and register multi/single threaded basic file logger. 71 // Basic logger simply writes to given file without any limitatons or rotations. 72 // 73 std::shared_ptr<logger> basic_logger_mt(const std::string& logger_name, const filename_t& filename, bool truncate = false); 74 std::shared_ptr<logger> basic_logger_st(const std::string& logger_name, const filename_t& filename, bool truncate = false); 75 76 // 77 // Create and register multi/single threaded rotating file logger 78 // 79 std::shared_ptr<logger> rotating_logger_mt(const std::string& logger_name, const filename_t& filename, size_t max_file_size, size_t max_files); 80 std::shared_ptr<logger> rotating_logger_st(const std::string& logger_name, const filename_t& filename, size_t max_file_size, size_t max_files); 81 82 // 83 // Create file logger which creates new file on the given time (default in midnight): 84 // 85 std::shared_ptr<logger> daily_logger_mt(const std::string& logger_name, const filename_t& filename, int hour=0, int minute=0); 86 std::shared_ptr<logger> daily_logger_st(const std::string& logger_name, const filename_t& filename, int hour=0, int minute=0); 87 88 // 89 // Create and register stdout/stderr loggers 90 // 91 std::shared_ptr<logger> stdout_logger_mt(const std::string& logger_name); 92 std::shared_ptr<logger> stdout_logger_st(const std::string& logger_name); 93 std::shared_ptr<logger> stderr_logger_mt(const std::string& logger_name); 94 std::shared_ptr<logger> stderr_logger_st(const std::string& logger_name); 95 // 96 // Create and register colored stdout/stderr loggers 97 // 98 std::shared_ptr<logger> stdout_color_mt(const std::string& logger_name); 99 std::shared_ptr<logger> stdout_color_st(const std::string& logger_name); 100 std::shared_ptr<logger> stderr_color_mt(const std::string& logger_name); 101 std::shared_ptr<logger> stderr_color_st(const std::string& logger_name); 102 103 104 // 105 // Create and register a syslog logger 106 // 107 #ifdef SPDLOG_ENABLE_SYSLOG 108 std::shared_ptr<logger> syslog_logger(const std::string& logger_name, const std::string& ident = "", int syslog_option = 0); 109 #endif 110 111 #if defined(__ANDROID__) 112 std::shared_ptr<logger> android_logger(const std::string& logger_name, const std::string& tag = "spdlog"); 113 #endif 114 115 // Create and register a logger a single sink 116 std::shared_ptr<logger> create(const std::string& logger_name, const sink_ptr& sink); 117 118 // Create and register a logger with multiple sinks 119 std::shared_ptr<logger> create(const std::string& logger_name, sinks_init_list sinks); 120 template<class It> 121 std::shared_ptr<logger> create(const std::string& logger_name, const It& sinks_begin, const It& sinks_end); 122 123 124 // Create and register a logger with templated sink type 125 // Example: 126 // spdlog::create<daily_file_sink_st>("mylog", "dailylog_filename", "txt"); 127 template <typename Sink, typename... Args> 128 std::shared_ptr<spdlog::logger> create(const std::string& logger_name, Args...); 129 130 131 // Register the given logger with the given name 132 void register_logger(std::shared_ptr<logger> logger); 133 134 // Apply a user defined function on all registered loggers 135 // Example: 136 // spdlog::apply_all([&](std::shared_ptr<spdlog::logger> l) {l->flush();}); 137 void apply_all(std::function<void(std::shared_ptr<logger>)> fun); 138 139 // Drop the reference to the given logger 140 void drop(const std::string &name); 141 142 // Drop all references from the registry 143 void drop_all(); 144 145 146 /////////////////////////////////////////////////////////////////////////////// 147 // 148 // Trace & Debug can be switched on/off at compile time for zero cost debug statements. 149 // Uncomment SPDLOG_DEBUG_ON/SPDLOG_TRACE_ON in teakme.h to enable. 150 // SPDLOG_TRACE(..) will also print current file and line. 151 // 152 // Example: 153 // spdlog::set_level(spdlog::level::trace); 154 // SPDLOG_TRACE(my_logger, "some trace message"); 155 // SPDLOG_TRACE(my_logger, "another trace message {} {}", 1, 2); 156 // SPDLOG_DEBUG(my_logger, "some debug message {} {}", 3, 4); 157 /////////////////////////////////////////////////////////////////////////////// 158 159 #ifdef SPDLOG_TRACE_ON 160 #define SPDLOG_STR_H(x) #x 161 #define SPDLOG_STR_HELPER(x) SPDLOG_STR_H(x) 162 #define SPDLOG_TRACE(logger, ...) logger->trace("[" __FILE__ " line #" SPDLOG_STR_HELPER(__LINE__) "] " __VA_ARGS__) 163 #else 164 #define SPDLOG_TRACE(logger, ...) 165 #endif 166 167 #ifdef SPDLOG_DEBUG_ON 168 #define SPDLOG_DEBUG(logger, ...) logger->debug(__VA_ARGS__) 169 #else 170 #define SPDLOG_DEBUG(logger, ...) 171 #endif 172 173 174 } 175 176 177 #include <spdlog/details/spdlog_impl.h> 178