registry.h 4.2 KB

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