thread_pool_metrics.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <kcenon/thread/metrics/metrics_base.h>
 
namespace kcenon::thread::metrics {
 
class ThreadPoolMetrics : public MetricsBase {
public:
    struct Snapshot {
        std::uint64_t tasks_submitted;
        std::uint64_t tasks_enqueued;
        std::uint64_t tasks_executed;
        std::uint64_t tasks_failed;
        std::uint64_t total_busy_time_ns;
        std::uint64_t total_idle_time_ns;
    };
 
    ThreadPoolMetrics() = default;
 
    ~ThreadPoolMetrics() override = default;
 
    void record_enqueue(std::size_t count = 1) {
        tasks_enqueued_.fetch_add(count, std::memory_order_relaxed);
    }
 
    [[nodiscard]] std::uint64_t tasks_enqueued() const {
        return tasks_enqueued_.load(std::memory_order_relaxed);
    }
 
    void reset() override {
        MetricsBase::reset();
        tasks_enqueued_.store(0, std::memory_order_relaxed);
    }
 
    [[nodiscard]] Snapshot snapshot() const {
        return Snapshot{
            tasks_submitted(),
            tasks_enqueued_.load(std::memory_order_relaxed),
            tasks_executed(),
            tasks_failed(),
            total_busy_time_ns(),
            total_idle_time_ns(),
        };
    }
 
private:
    std::atomic<std::uint64_t> tasks_enqueued_{0};
};
 
} // namespace kcenon::thread::metrics