logger-inl.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #ifndef SPDLOG_HEADER_ONLY
  5. #include <spdlog/logger.h>
  6. #endif
  7. #include <spdlog/details/backtracer.h>
  8. #include <spdlog/pattern_formatter.h>
  9. #include <spdlog/sinks/sink.h>
  10. #include <cstdio>
  11. namespace spdlog {
  12. // public methods
  13. SPDLOG_INLINE logger::logger(const logger &other)
  14. : name_(other.name_),
  15. sinks_(other.sinks_),
  16. level_(other.level_.load(std::memory_order_relaxed)),
  17. flush_level_(other.flush_level_.load(std::memory_order_relaxed)),
  18. custom_err_handler_(other.custom_err_handler_),
  19. tracer_(other.tracer_) {}
  20. SPDLOG_INLINE logger::logger(logger &&other) SPDLOG_NOEXCEPT
  21. : name_(std::move(other.name_)),
  22. sinks_(std::move(other.sinks_)),
  23. level_(other.level_.load(std::memory_order_relaxed)),
  24. flush_level_(other.flush_level_.load(std::memory_order_relaxed)),
  25. custom_err_handler_(std::move(other.custom_err_handler_)),
  26. tracer_(std::move(other.tracer_))
  27. {}
  28. SPDLOG_INLINE logger &logger::operator=(logger other) SPDLOG_NOEXCEPT {
  29. this->swap(other);
  30. return *this;
  31. }
  32. SPDLOG_INLINE void logger::swap(spdlog::logger &other) SPDLOG_NOEXCEPT {
  33. name_.swap(other.name_);
  34. sinks_.swap(other.sinks_);
  35. // swap level_
  36. auto other_level = other.level_.load();
  37. auto my_level = level_.exchange(other_level);
  38. other.level_.store(my_level);
  39. // swap flush level_
  40. other_level = other.flush_level_.load();
  41. my_level = flush_level_.exchange(other_level);
  42. other.flush_level_.store(my_level);
  43. custom_err_handler_.swap(other.custom_err_handler_);
  44. std::swap(tracer_, other.tracer_);
  45. }
  46. SPDLOG_INLINE void swap(logger &a, logger &b) { a.swap(b); }
  47. SPDLOG_INLINE void logger::set_level(level::level_enum log_level) { level_.store(log_level); }
  48. SPDLOG_INLINE level::level_enum logger::level() const {
  49. return static_cast<level::level_enum>(level_.load(std::memory_order_relaxed));
  50. }
  51. SPDLOG_INLINE const std::string &logger::name() const { return name_; }
  52. // set formatting for the sinks in this logger.
  53. // each sink will get a separate instance of the formatter object.
  54. SPDLOG_INLINE void logger::set_formatter(std::unique_ptr<formatter> f) {
  55. for (auto it = sinks_.begin(); it != sinks_.end(); ++it) {
  56. if (std::next(it) == sinks_.end()) {
  57. // last element - we can be move it.
  58. (*it)->set_formatter(std::move(f));
  59. break; // to prevent clang-tidy warning
  60. } else {
  61. (*it)->set_formatter(f->clone());
  62. }
  63. }
  64. }
  65. SPDLOG_INLINE void logger::set_pattern(std::string pattern, pattern_time_type time_type) {
  66. auto new_formatter = details::make_unique<pattern_formatter>(std::move(pattern), time_type);
  67. set_formatter(std::move(new_formatter));
  68. }
  69. // create new backtrace sink and move to it all our child sinks
  70. SPDLOG_INLINE void logger::enable_backtrace(size_t n_messages) { tracer_.enable(n_messages); }
  71. // restore orig sinks and level and delete the backtrace sink
  72. SPDLOG_INLINE void logger::disable_backtrace() { tracer_.disable(); }
  73. SPDLOG_INLINE void logger::dump_backtrace() { dump_backtrace_(); }
  74. // flush functions
  75. SPDLOG_INLINE void logger::flush() { flush_(); }
  76. SPDLOG_INLINE void logger::flush_on(level::level_enum log_level) { flush_level_.store(log_level); }
  77. SPDLOG_INLINE level::level_enum logger::flush_level() const {
  78. return static_cast<level::level_enum>(flush_level_.load(std::memory_order_relaxed));
  79. }
  80. // sinks
  81. SPDLOG_INLINE const std::vector<sink_ptr> &logger::sinks() const { return sinks_; }
  82. SPDLOG_INLINE std::vector<sink_ptr> &logger::sinks() { return sinks_; }
  83. // error handler
  84. SPDLOG_INLINE void logger::set_error_handler(err_handler handler) {
  85. custom_err_handler_ = std::move(handler);
  86. }
  87. // create new logger with same sinks and configuration.
  88. SPDLOG_INLINE std::shared_ptr<logger> logger::clone(std::string logger_name) {
  89. auto cloned = std::make_shared<logger>(*this);
  90. cloned->name_ = std::move(logger_name);
  91. return cloned;
  92. }
  93. // protected methods
  94. SPDLOG_INLINE void logger::log_it_(const spdlog::details::log_msg &log_msg,
  95. bool log_enabled,
  96. bool traceback_enabled) {
  97. if (log_enabled) {
  98. sink_it_(log_msg);
  99. }
  100. if (traceback_enabled) {
  101. tracer_.push_back(log_msg);
  102. }
  103. }
  104. SPDLOG_INLINE void logger::sink_it_(const details::log_msg &msg) {
  105. for (auto &sink : sinks_) {
  106. if (sink->should_log(msg.level)) {
  107. SPDLOG_TRY { sink->log(msg); }
  108. SPDLOG_LOGGER_CATCH(msg.source)
  109. }
  110. }
  111. if (should_flush_(msg)) {
  112. flush_();
  113. }
  114. }
  115. SPDLOG_INLINE void logger::flush_() {
  116. for (auto &sink : sinks_) {
  117. SPDLOG_TRY { sink->flush(); }
  118. SPDLOG_LOGGER_CATCH(source_loc())
  119. }
  120. }
  121. SPDLOG_INLINE void logger::dump_backtrace_() {
  122. using details::log_msg;
  123. if (tracer_.enabled() && !tracer_.empty()) {
  124. sink_it_(
  125. log_msg{name(), level::info, "****************** Backtrace Start ******************"});
  126. tracer_.foreach_pop([this](const log_msg &msg) { this->sink_it_(msg); });
  127. sink_it_(
  128. log_msg{name(), level::info, "****************** Backtrace End ********************"});
  129. }
  130. }
  131. SPDLOG_INLINE bool logger::should_flush_(const details::log_msg &msg) {
  132. auto flush_level = flush_level_.load(std::memory_order_relaxed);
  133. return (msg.level >= flush_level) && (msg.level != level::off);
  134. }
  135. SPDLOG_INLINE void logger::err_handler_(const std::string &msg) {
  136. if (custom_err_handler_) {
  137. custom_err_handler_(msg);
  138. } else {
  139. using std::chrono::system_clock;
  140. static std::mutex mutex;
  141. static std::chrono::system_clock::time_point last_report_time;
  142. static size_t err_counter = 0;
  143. std::lock_guard<std::mutex> lk{mutex};
  144. auto now = system_clock::now();
  145. err_counter++;
  146. if (now - last_report_time < std::chrono::seconds(1)) {
  147. return;
  148. }
  149. last_report_time = now;
  150. auto tm_time = details::os::localtime(system_clock::to_time_t(now));
  151. char date_buf[64];
  152. std::strftime(date_buf, sizeof(date_buf), "%Y-%m-%d %H:%M:%S", &tm_time);
  153. #if defined(USING_R) && defined(R_R_H) // if in R environment
  154. REprintf("[*** LOG ERROR #%04zu ***] [%s] [%s] %s\n", err_counter, date_buf, name().c_str(),
  155. msg.c_str());
  156. #else
  157. std::fprintf(stderr, "[*** LOG ERROR #%04zu ***] [%s] [%s] %s\n", err_counter, date_buf,
  158. name().c_str(), msg.c_str());
  159. #endif
  160. }
  161. }
  162. } // namespace spdlog