collector_plugin.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 <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include "../interfaces/metric_types_adapter.h"
#include "../collectors/collector_base.h"
 
namespace kcenon {
namespace monitoring {
 
enum class plugin_category {
    system,      
    hardware,    
    platform,    
    network,     
    process,     
    custom       
};
 
struct plugin_metadata {
    std::string_view name;                    
    std::string_view description;             
    plugin_category category;                 
    std::string_view version;                 
    std::vector<std::string_view> dependencies; 
    bool requires_platform_support{false};    
};
 
class collector_plugin {
public:
    virtual ~collector_plugin() = default;
 
    virtual auto name() const -> std::string_view = 0;
 
    virtual auto collect() -> std::vector<metric> = 0;
 
    virtual auto interval() const -> std::chrono::milliseconds = 0;
 
    virtual auto is_available() const -> bool = 0;
 
    virtual auto get_metadata() const -> plugin_metadata {
        return plugin_metadata{
            .name = name(),
            .description = "",
            .category = plugin_category::custom,
            .version = "1.0.0",
            .dependencies = {},
            .requires_platform_support = false
        };
    }
 
    virtual auto initialize(const config_map& /* config */) -> bool {
        return true;
    }
 
    virtual void shutdown() {}
 
    virtual auto get_statistics() const -> stats_map {
        return {};
    }
 
    virtual auto get_metric_types() const -> std::vector<std::string> = 0;
};
 
using plugin_factory_fn = std::unique_ptr<collector_plugin> (*)();
 
} // namespace monitoring
} // namespace kcenon