Pure virtual interface for metric collector plugins. More...

#include <collector_plugin.h>

Inheritance diagram for kcenon::monitoring::collector_plugin:

Collaboration diagram for kcenon::monitoring::collector_plugin:

Public Member Functions
virtual	~collector_plugin ()=default

virtual auto	name () const -> std::string_view=0
	Get the unique name of this plugin.

virtual auto	collect () -> std::vector< metric >=0
	Collect current metrics from this plugin.

virtual auto	interval () const -> std::chrono::milliseconds=0
	Get the collection interval for this plugin.

virtual auto	is_available () const -> bool=0
	Check if this plugin is available on the current system.

virtual auto	get_metadata () const -> plugin_metadata
	Get plugin metadata.

virtual auto	initialize (const config_map &) -> bool
	Initialize plugin with configuration.

virtual void	shutdown ()
	Shutdown plugin and release resources.

virtual auto	get_statistics () const -> stats_map
	Get plugin statistics.

virtual auto	get_metric_types () const -> std::vector< std::string >=0
	Get supported metric types.

Detailed Description

Pure virtual interface for metric collector plugins.

This interface defines the contract that all metric collector plugins must implement. It supports both built-in collectors and dynamically loaded plugins.

Thread Safety:

collect() may be called concurrently from multiple threads
Implementations MUST be thread-safe or document restrictions
is_available() should be lock-free if possible

Lifecycle:

Construction (via factory or direct instantiation)
is_available() check before registration
Periodic collect() calls based on interval()
Destruction on unregistration or shutdown

Examples: plugin_example/example_plugin.cpp.

Definition at line 139 of file collector_plugin.h.

Constructor & Destructor Documentation

◆ ~collector_plugin()

virtual kcenon::monitoring::collector_plugin::~collector_plugin ( )

virtualdefault

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Member Function Documentation

◆ collect()

virtual auto kcenon::monitoring::collector_plugin::collect ( ) -> std::vector< metric >

pure virtual

Collect current metrics from this plugin.

Returns: Vector of collected metrics

This method is called periodically based on interval(). Implementations should:

Return quickly (< 100ms recommended)
Handle errors gracefully (return empty vector on failure)
Be thread-safe if concurrent collection is enabled
Avoid blocking I/O when possible

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

◆ get_metadata()

virtual auto kcenon::monitoring::collector_plugin::get_metadata ( ) const -> plugin_metadata

inlinevirtual

Get plugin metadata.

Returns: Metadata describing this plugin

Default implementation returns minimal metadata. Override to provide rich plugin information.

Reimplemented in example_plugin, kcenon::monitoring::battery_collector, kcenon::monitoring::container_collector, kcenon::monitoring::gpu_collector, kcenon::monitoring::interrupt_collector, kcenon::monitoring::network_metrics_collector, kcenon::monitoring::power_collector, kcenon::monitoring::temperature_collector, and kcenon::monitoring::uptime_collector.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Definition at line 200 of file collector_plugin.h.

                                                         {
        return plugin_metadata{
            .name = name(),
            .description = "",
            .category = plugin_category::custom,
            .version = "1.0.0",
            .dependencies = {},
            .requires_platform_support = false
        };
    }

References kcenon::monitoring::custom, and name().

Here is the call graph for this function:

◆ get_metric_types()

virtual auto kcenon::monitoring::collector_plugin::get_metric_types ( ) const -> std::vector< std::string >

pure virtual

Get supported metric types.

Returns: Vector of metric type names this plugin produces

Used for filtering and documentation.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

◆ get_statistics()

virtual auto kcenon::monitoring::collector_plugin::get_statistics ( ) const -> stats_map

inlinevirtual

Get plugin statistics.

Returns: Map of statistic name to value

Optional: Override to provide plugin-specific statistics.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Definition at line 237 of file collector_plugin.h.

                                                     {
        return {};
    }

◆ initialize()

virtual auto kcenon::monitoring::collector_plugin::initialize ( const config_map & ) -> bool

inlinevirtual

Initialize plugin with configuration.

Parameters

config Configuration key-value pairs

Returns: True if initialization succeeded

Called once after plugin registration. Optional: Default implementation always succeeds.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Definition at line 219 of file collector_plugin.h.

                                                         {
        return true;
    }

◆ interval()

virtual auto kcenon::monitoring::collector_plugin::interval ( ) const -> std::chrono::milliseconds

pure virtual

Get the collection interval for this plugin.

Returns: Collection interval in milliseconds

The registry uses this value to schedule collection tasks. Typical values:

Fast metrics (CPU, memory): 1-5 seconds
Slow metrics (disk, network): 10-60 seconds
Very slow metrics (SMART data): 5-15 minutes

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

◆ is_available()

virtual auto kcenon::monitoring::collector_plugin::is_available ( ) const -> bool

pure virtual

Check if this plugin is available on the current system.

Returns: True if plugin can collect metrics, false otherwise

Availability checks may include:

Platform compatibility (Linux-only, Windows-only)
Hardware presence (GPU, sensors)
Permission checks (root required)
Resource availability (proc filesystem, WMI)

The registry may skip unavailable plugins during registration.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

◆ name()

virtual auto kcenon::monitoring::collector_plugin::name ( ) const -> std::string_view

pure virtual

Get the unique name of this plugin.

Returns: Plugin name (must be unique within registry)

The name is used for:

Plugin lookup and discovery
Configuration mapping
Metric tagging (added as "collector" tag)

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Referenced by get_metadata().

Here is the caller graph for this function:

◆ shutdown()

virtual void kcenon::monitoring::collector_plugin::shutdown ( )

inlinevirtual

Shutdown plugin and release resources.

Called before plugin destruction. Optional: Default implementation is no-op.

Reimplemented in example_plugin, kcenon::monitoring::battery_collector, kcenon::monitoring::container_collector, kcenon::monitoring::gpu_collector, kcenon::monitoring::power_collector, and kcenon::monitoring::temperature_collector.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/plugins/collector_plugin.h.

Definition at line 229 of file collector_plugin.h.

229{}

The documentation for this class was generated from the following file:

include/kcenon/monitoring/plugins/collector_plugin.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~collector_plugin()

Member Function Documentation

◆ collect()

◆ get_metadata()

◆ get_metric_types()

◆ get_statistics()

◆ initialize()

◆ interval()

◆ is_available()

◆ name()

◆ shutdown()