1// Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
2// Distributed under the MIT License (http://opensource.org/licenses/MIT)
3
4#pragma once
5
6// Loggers registry of unique name->logger pointer
7// An attempt to create a logger with an already existing name will result with spdlog_ex exception.
8// If user requests a non existing logger, nullptr will be returned
9// This class is thread safe
10
11#include <spdlog/common.h>
12#include <spdlog/details/periodic_worker.h>
13
14#include <chrono>
15#include <functional>
16#include <memory>
17#include <string>
18#include <unordered_map>
19#include <mutex>
20
21namespace spdlog {
22class logger;
23
24namespace details {
25class thread_pool;
26
27class SPDLOG_API registry
28{
29public:
30 using log_levels = std::unordered_map<std::string, level::level_enum>;
31 registry(const registry &) = delete;
32 registry &operator=(const registry &) = delete;
33
34 void register_logger(std::shared_ptr<logger> new_logger);
35 void initialize_logger(std::shared_ptr<logger> new_logger);
36 std::shared_ptr<logger> get(const std::string &logger_name);
37 std::shared_ptr<logger> default_logger();
38
39 // Return raw ptr to the default logger.
40 // To be used directly by the spdlog default api (e.g. spdlog::info)
41 // This make the default API faster, but cannot be used concurrently with set_default_logger().
42 // e.g do not call set_default_logger() from one thread while calling spdlog::info() from another.
43 logger *get_default_raw();
44
45 // set default logger.
46 // default logger is stored in default_logger_ (for faster retrieval) and in the loggers_ map.
47 void set_default_logger(std::shared_ptr<logger> new_default_logger);
48
49 void set_tp(std::shared_ptr<thread_pool> tp);
50
51 std::shared_ptr<thread_pool> get_tp();
52
53 // Set global formatter. Each sink in each logger will get a clone of this object
54 void set_formatter(std::unique_ptr<formatter> formatter);
55
56 void enable_backtrace(size_t n_messages);
57
58 void disable_backtrace();
59
60 void set_level(level::level_enum log_level);
61
62 void flush_on(level::level_enum log_level);
63
64 template<typename Rep, typename Period>
65 void flush_every(std::chrono::duration<Rep, Period> interval)
66 {
67 std::lock_guard<std::mutex> lock(flusher_mutex_);
68 auto clbk = [this]() { this->flush_all(); };
69 periodic_flusher_ = details::make_unique<periodic_worker>(clbk, interval);
70 }
71
72 void set_error_handler(err_handler handler);
73
74 void apply_all(const std::function<void(const std::shared_ptr<logger>)> &fun);
75
76 void flush_all();
77
78 void drop(const std::string &logger_name);
79
80 void drop_all();
81
82 // clean all resources and threads started by the registry
83 void shutdown();
84
85 std::recursive_mutex &tp_mutex();
86
87 void set_automatic_registration(bool automatic_registration);
88
89 // set levels for all existing/future loggers. global_level can be null if should not set.
90 void set_levels(log_levels levels, level::level_enum *global_level);
91
92 static registry &instance();
93
94private:
95 registry();
96 ~registry();
97
98 void throw_if_exists_(const std::string &logger_name);
99 void register_logger_(std::shared_ptr<logger> new_logger);
100 bool set_level_from_cfg_(logger *logger);
101 std::mutex logger_map_mutex_, flusher_mutex_;
102 std::recursive_mutex tp_mutex_;
103 std::unordered_map<std::string, std::shared_ptr<logger>> loggers_;
104 log_levels log_levels_;
105 std::unique_ptr<formatter> formatter_;
106 spdlog::level::level_enum global_log_level_ = level::info;
107 level::level_enum flush_level_ = level::off;
108 err_handler err_handler_;
109 std::shared_ptr<thread_pool> tp_;
110 std::unique_ptr<periodic_worker> periodic_flusher_;
111 std::shared_ptr<logger> default_logger_;
112 bool automatic_registration_ = true;
113 size_t backtrace_n_messages_ = 0;
114};
115
116} // namespace details
117} // namespace spdlog
118
119#ifdef SPDLOG_HEADER_ONLY
120# include "registry-inl.h"
121#endif
122