ThrottleLogger.h

Go to the documentation of this file.

 
#pragma once
#include "Logging.h"
#include "SpinLock.h"
#include <chrono>
 
namespace catapult { namespace utils {
 
    class ThrottleLogger {
    private:
        using Clock = std::chrono::steady_clock;
 
    public:
        explicit ThrottleLogger(uint64_t throttleMillis)
                : m_throttleMillis(throttleMillis)
                , m_counter(0)
        {}
 
    public:
        uint32_t counter() const {
            return m_counter;
        }
 
    public:
        bool isThrottled() {
            ++m_counter;
 
            SpinLockGuard guard(m_lock);
            auto now = Clock::now();
            if (Clock::time_point() != m_last && millis(now) < m_throttleMillis)
                return true;
 
            m_last = now;
            return false;
        }
 
    private:
        uint64_t millis(const Clock::time_point& now) const {
            auto elapsedDuration = now - m_last;
            return static_cast<uint64_t>(std::chrono::duration_cast<std::chrono::milliseconds>(elapsedDuration).count());
        }
 
    private:
        uint64_t m_throttleMillis;
        std::atomic<uint32_t> m_counter; // atomic to allow increment / access outside of m_lock
        Clock::time_point m_last; // protected by m_lock
        utils::SpinLock m_lock;
    };
 
#define CATAPULT_LOG_THROTTLE(LEVEL, THROTTLE_MILLIS) \
    static utils::ThrottleLogger BOOST_LOG_UNIQUE_IDENTIFIER_NAME_INTERNAL(throttle_logger, __LINE__)(THROTTLE_MILLIS); \
    if (!BOOST_LOG_UNIQUE_IDENTIFIER_NAME_INTERNAL(throttle_logger, __LINE__).isThrottled()) \
        CATAPULT_LOG(LEVEL) << "[" << BOOST_LOG_UNIQUE_IDENTIFIER_NAME_INTERNAL(throttle_logger, __LINE__).counter() << " log count] "
}}