metrics_provider.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 <chrono>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
// Forward declarations for existing types
#include "../collectors/battery_collector.h"
#include "../collectors/temperature_collector.h"
 
namespace kcenon {
namespace monitoring {
namespace platform {
 
struct uptime_info {
    int64_t uptime_seconds{0};          
    int64_t idle_seconds{0};            
    std::chrono::system_clock::time_point boot_time;  
    bool available{false};              
};
 
struct context_switch_info {
    uint64_t total_switches{0};         
    uint64_t voluntary_switches{0};     
    uint64_t involuntary_switches{0};   
    double switches_per_second{0.0};    
    bool available{false};              
    std::chrono::system_clock::time_point timestamp;
};
 
struct fd_info {
    uint64_t open_fds{0};               
    uint64_t max_fds{0};                
    double usage_percent{0.0};          
    bool available{false};              
};
 
struct inode_info {
    uint64_t total_inodes{0};           
    uint64_t used_inodes{0};            
    uint64_t free_inodes{0};            
    double usage_percent{0.0};          
    std::string filesystem;             
    bool available{false};              
};
 
struct tcp_state_info {
    uint64_t established{0};            
    uint64_t syn_sent{0};               
    uint64_t syn_recv{0};               
    uint64_t fin_wait1{0};              
    uint64_t fin_wait2{0};              
    uint64_t time_wait{0};              
    uint64_t close_wait{0};             
    uint64_t last_ack{0};               
    uint64_t listen{0};                 
    uint64_t closing{0};                
    uint64_t total{0};                  
    bool available{false};              
};
 
struct socket_buffer_info {
    uint64_t rx_buffer_size{0};         
    uint64_t tx_buffer_size{0};         
    uint64_t rx_buffer_used{0};         
    uint64_t tx_buffer_used{0};         
    bool available{false};              
};
 
struct interrupt_info {
    std::string name;                   
    uint64_t count{0};                  
    uint64_t irq_number{0};             
    bool available{false};              
};
 
struct power_info {
    double power_watts{0.0};            
    double voltage_volts{0.0};          
    double current_amps{0.0};           
    std::string source;                 
    bool available{false};              
};
 
struct gpu_info {
    std::string name;                   
    std::string vendor;                 
    double usage_percent{0.0};          
    double memory_used_mb{0.0};         
    double memory_total_mb{0.0};        
    double temperature_celsius{0.0};    
    double power_watts{0.0};            
    bool available{false};              
};
 
struct security_info {
    bool firewall_enabled{false};       
    uint64_t failed_login_attempts{0};  
    uint64_t active_sessions{0};        
    std::string security_level;         
    bool available{false};              
};
 
class metrics_provider {
   public:
    virtual ~metrics_provider() = default;
 
    // Non-copyable, non-moveable
    metrics_provider(const metrics_provider&) = delete;
    metrics_provider& operator=(const metrics_provider&) = delete;
    metrics_provider(metrics_provider&&) = delete;
    metrics_provider& operator=(metrics_provider&&) = delete;
 
    static std::unique_ptr<metrics_provider> create();
 
    virtual std::string get_platform_name() const = 0;
 
    // =========================================================================
    // Battery Metrics
    // =========================================================================
 
    virtual bool is_battery_available() const = 0;
 
    virtual std::vector<battery_reading> get_battery_readings() = 0;
 
    // =========================================================================
    // Temperature Metrics
    // =========================================================================
 
    virtual bool is_temperature_available() const = 0;
 
    virtual std::vector<temperature_reading> get_temperature_readings() = 0;
 
    // =========================================================================
    // Uptime Metrics
    // =========================================================================
 
    virtual uptime_info get_uptime() = 0;
 
    // =========================================================================
    // Context Switch Metrics
    // =========================================================================
 
    virtual context_switch_info get_context_switches() = 0;
 
    // =========================================================================
    // File Descriptor Metrics
    // =========================================================================
 
    virtual fd_info get_fd_stats() = 0;
 
    // =========================================================================
    // Inode Metrics
    // =========================================================================
 
    virtual std::vector<inode_info> get_inode_stats() = 0;
 
    // =========================================================================
    // TCP State Metrics
    // =========================================================================
 
    virtual tcp_state_info get_tcp_states() = 0;
 
    // =========================================================================
    // Socket Buffer Metrics
    // =========================================================================
 
    virtual socket_buffer_info get_socket_buffer_stats() = 0;
 
    // =========================================================================
    // Interrupt Metrics
    // =========================================================================
 
    virtual std::vector<interrupt_info> get_interrupt_stats() = 0;
 
    // =========================================================================
    // Power Metrics
    // =========================================================================
 
    virtual bool is_power_available() const = 0;
 
    virtual power_info get_power_info() = 0;
 
    // =========================================================================
    // GPU Metrics
    // =========================================================================
 
    virtual bool is_gpu_available() const = 0;
 
    virtual std::vector<gpu_info> get_gpu_info() = 0;
 
    // =========================================================================
    // Security Metrics
    // =========================================================================
 
    virtual security_info get_security_info() = 0;
 
   protected:
    metrics_provider() = default;
};
 
}  // namespace platform
}  // namespace monitoring
}  // namespace kcenon