temperature_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 sensor_type {
    unknown,      
    cpu,          
    gpu,          
    motherboard,  
    storage,      
    ambient,      
    other         
};
 
inline std::string sensor_type_to_string(sensor_type type) {
    switch (type) {
        case sensor_type::cpu:
            return "cpu";
        case sensor_type::gpu:
            return "gpu";
        case sensor_type::motherboard:
            return "motherboard";
        case sensor_type::storage:
            return "storage";
        case sensor_type::ambient:
            return "ambient";
        case sensor_type::other:
            return "other";
        default:
            return "unknown";
    }
}
 
struct temperature_sensor_info {
    std::string id;         
    std::string name;       
    std::string zone_path;  
    sensor_type type{sensor_type::unknown};  
};
 
struct temperature_reading {
    temperature_sensor_info sensor;          
    double temperature_celsius{0.0};         
    double critical_threshold_celsius{0.0};  
    double warning_threshold_celsius{0.0};   
    bool thresholds_available{false};        
    bool is_critical{false};                 
    bool is_warning{false};                  
    std::chrono::system_clock::time_point timestamp;  
};
 
// Forward declaration
namespace platform {
class metrics_provider;
}  // namespace platform
 
class temperature_info_collector {
   public:
    temperature_info_collector();
    ~temperature_info_collector();
 
    // Non-copyable, non-moveable due to internal state
    temperature_info_collector(const temperature_info_collector&) = delete;
    temperature_info_collector& operator=(const temperature_info_collector&) = delete;
    temperature_info_collector(temperature_info_collector&&) = delete;
    temperature_info_collector& operator=(temperature_info_collector&&) = delete;
 
    bool is_thermal_available() const;
 
    std::vector<temperature_sensor_info> enumerate_sensors();
 
    std::vector<temperature_reading> read_all_temperatures();
 
   private:
    std::unique_ptr<platform::metrics_provider> provider_;
};
 
class temperature_collector : public collector_plugin {
   public:
    temperature_collector();
    ~temperature_collector() override = default;
 
    // Non-copyable, non-moveable due to internal state
    temperature_collector(const temperature_collector&) = delete;
    temperature_collector& operator=(const temperature_collector&) = delete;
    temperature_collector(temperature_collector&&) = delete;
    temperature_collector& operator=(temperature_collector&&) = delete;
 
    // collector_plugin implementation
    auto name() const -> std::string_view override { return "temperature"; }
    auto collect() -> std::vector<metric> override;
    auto interval() const -> std::chrono::milliseconds override { return std::chrono::seconds(5); }
    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 = "Hardware temperature metrics from thermal sensors",
            .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<temperature_reading> get_last_readings() const;
 
    bool is_thermal_available() const;
 
   private:
    std::unique_ptr<temperature_info_collector> collector_;
 
    // Configuration
    bool enabled_{true};
    bool collect_thresholds_{true};
    bool collect_warnings_{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> sensors_found_{0};
    std::vector<temperature_reading> last_readings_;
 
    // Helper methods
    metric create_metric(const std::string& name, double value, const temperature_reading& reading,
                         const std::string& unit = "") const;
    void add_sensor_metrics(std::vector<metric>& metrics, const temperature_reading& reading);
};
 
}  // namespace monitoring
}  // namespace kcenon