power_collector.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <atomic>
#include <chrono>
#include <cstdint>
#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "../interfaces/metric_types_adapter.h"
#include "../plugins/collector_plugin.h"
 
namespace kcenon {
namespace monitoring {
 
enum class power_source_type {
    unknown,   
    battery,   
    ac,        
    usb,       
    wireless,  
    cpu,       
    gpu,       
    memory,    
    package,   
    platform,  
    other      
};
 
inline std::string power_source_type_to_string(power_source_type type) {
    switch (type) {
        case power_source_type::battery:
            return "battery";
        case power_source_type::ac:
            return "ac";
        case power_source_type::usb:
            return "usb";
        case power_source_type::wireless:
            return "wireless";
        case power_source_type::cpu:
            return "cpu";
        case power_source_type::gpu:
            return "gpu";
        case power_source_type::memory:
            return "memory";
        case power_source_type::package:
            return "package";
        case power_source_type::platform:
            return "platform";
        case power_source_type::other:
            return "other";
        default:
            return "unknown";
    }
}
 
struct power_source_info {
    std::string id;    
    std::string name;  
    std::string path;  
    power_source_type type{power_source_type::unknown};  
};
 
struct power_reading {
    power_source_info source;  
 
    // Power metrics
    double power_watts{0.0};        
    double energy_joules{0.0};      
    double power_limit_watts{0.0};  
 
    // Voltage metrics
    double voltage_volts{0.0};  
 
    // Battery-specific metrics
    double battery_percent{0.0};  
    double battery_capacity_wh{0.0};  
    double battery_charge_rate{0.0};  
    bool is_charging{false};          
    bool is_discharging{false};       
    bool is_full{false};              
 
    // Availability flags
    bool power_available{false};   
    bool battery_available{false}; 
    bool limits_available{false};  
 
    std::chrono::system_clock::time_point timestamp;  
};
 
// Forward declaration
namespace platform {
class metrics_provider;
}  // namespace platform
 
class power_info_collector {
   public:
    power_info_collector();
    ~power_info_collector();
 
    // Non-copyable, non-moveable due to internal state
    power_info_collector(const power_info_collector&) = delete;
    power_info_collector& operator=(const power_info_collector&) = delete;
    power_info_collector(power_info_collector&&) = delete;
    power_info_collector& operator=(power_info_collector&&) = delete;
 
    bool is_power_available() const;
 
    std::vector<power_source_info> enumerate_sources();
 
    std::vector<power_reading> read_all_power();
 
   private:
    std::unique_ptr<platform::metrics_provider> provider_;
};
 
class power_collector : public collector_plugin {
   public:
    power_collector();
    ~power_collector() override = default;
 
    // Non-copyable, non-moveable due to internal state
    power_collector(const power_collector&) = delete;
    power_collector& operator=(const power_collector&) = delete;
    power_collector(power_collector&&) = delete;
    power_collector& operator=(power_collector&&) = delete;
 
    // collector_plugin implementation
    auto name() const -> std::string_view override { return "power"; }
    auto collect() -> std::vector<metric> override;
    auto interval() const -> std::chrono::milliseconds override { return std::chrono::seconds(10); }
    auto is_available() const -> bool override;
    auto get_metric_types() const -> std::vector<std::string> override;
 
    auto get_metadata() const -> plugin_metadata override {
        return plugin_metadata{
            .name = name(),
            .description = "Power consumption metrics from various sources",
            .category = plugin_category::hardware,
            .version = "1.0.0",
            .dependencies = {},
            .requires_platform_support = true
        };
    }
 
    auto initialize(const config_map& config) -> bool override;
    void shutdown() override {}
    auto get_statistics() const -> stats_map override;
 
    std::vector<power_reading> get_last_readings() const;
 
    bool is_power_available() const;
 
   private:
    std::unique_ptr<power_info_collector> collector_;
 
    // Configuration
    bool enabled_{true};
    bool collect_battery_{true};
    bool collect_rapl_{true};
 
    // Statistics
    mutable std::mutex stats_mutex_;
    std::atomic<size_t> collection_count_{0};
    std::atomic<size_t> collection_errors_{0};
    std::atomic<size_t> sources_found_{0};
    std::vector<power_reading> last_readings_;
 
    // Helper methods
    metric create_metric(const std::string& name, double value, const power_reading& reading,
                         const std::string& unit = "") const;
    void add_source_metrics(std::vector<metric>& metrics, const power_reading& reading);
};
 
}  // namespace monitoring
}  // namespace kcenon