ringbuffer_sink.h 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #include "spdlog/sinks/base_sink.h"
  5. #include "spdlog/details/circular_q.h"
  6. #include "spdlog/details/log_msg_buffer.h"
  7. #include "spdlog/details/null_mutex.h"
  8. #include <mutex>
  9. #include <string>
  10. #include <vector>
  11. namespace spdlog {
  12. namespace sinks {
  13. /*
  14. * Ring buffer sink
  15. */
  16. template<typename Mutex>
  17. class ringbuffer_sink final : public base_sink<Mutex>
  18. {
  19. public:
  20. explicit ringbuffer_sink(size_t n_items)
  21. : q_{n_items}
  22. {}
  23. std::vector<details::log_msg_buffer> last_raw(size_t lim = 0)
  24. {
  25. std::lock_guard<Mutex> lock(base_sink<Mutex>::mutex_);
  26. auto items_available = q_.size();
  27. auto n_items = lim > 0 ? (std::min)(lim, items_available) : items_available;
  28. std::vector<details::log_msg_buffer> ret;
  29. ret.reserve(n_items);
  30. for (size_t i = (items_available - n_items); i < items_available; i++)
  31. {
  32. ret.push_back(q_.at(i));
  33. }
  34. return ret;
  35. }
  36. std::vector<std::string> last_formatted(size_t lim = 0)
  37. {
  38. std::lock_guard<Mutex> lock(base_sink<Mutex>::mutex_);
  39. auto items_available = q_.size();
  40. auto n_items = lim > 0 ? (std::min)(lim, items_available) : items_available;
  41. std::vector<std::string> ret;
  42. ret.reserve(n_items);
  43. for (size_t i = (items_available - n_items); i < items_available; i++)
  44. {
  45. memory_buf_t formatted;
  46. base_sink<Mutex>::formatter_->format(q_.at(i), formatted);
  47. ret.push_back(SPDLOG_BUF_TO_STRING(formatted));
  48. }
  49. return ret;
  50. }
  51. protected:
  52. void sink_it_(const details::log_msg &msg) override
  53. {
  54. q_.push_back(details::log_msg_buffer{msg});
  55. }
  56. void flush_() override {}
  57. private:
  58. details::circular_q<details::log_msg_buffer> q_;
  59. };
  60. using ringbuffer_sink_mt = ringbuffer_sink<std::mutex>;
  61. using ringbuffer_sink_st = ringbuffer_sink<details::null_mutex>;
  62. } // namespace sinks
  63. } // namespace spdlog