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