Utility class to aggregate metrics from multiple monitorable components. More...

#include <monitorable_interface.h>

Collaboration diagram for kcenon::monitoring::monitoring_aggregator:

Public Member Functions
	monitoring_aggregator (const std::string &id="aggregator")
	Constructor.

void	add_component (std::shared_ptr< monitorable_interface > component)
	Add a component to monitor.

bool	remove_component (const std::string &id)
	Remove a component by ID.

common::Result< monitoring_data >	collect_all () const
	Collect data from all components.

std::shared_ptr< monitorable_interface >	get_component (const std::string &id) const
	Get a specific component by ID.

std::vector< std::string >	get_component_ids () const
	Get all component IDs.

void	clear ()
	Clear all components.

std::size_t	size () const
	Get the number of registered components.

Private Attributes
std::vector< std::shared_ptr< monitorable_interface > >	components_

std::string	aggregator_id_

Detailed Description

Utility class to aggregate metrics from multiple monitorable components.

Collects and merges monitoring data from multiple components into a single aggregated view. Useful for creating dashboards or exporting combined metrics from a subsystem.

Thread Safety:: This class is NOT thread-safe. External synchronization is required when modifying the component list from multiple threads.

Definition at line 453 of file monitorable_interface.h.

Constructor & Destructor Documentation

◆ monitoring_aggregator()

kcenon::monitoring::monitoring_aggregator::monitoring_aggregator ( const std::string & id = "aggregator" )

inlineexplicit

Constructor.

Parameters

id	Identifier for this aggregator

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 463 of file monitorable_interface.h.

464 : aggregator_id_(id) {}

kcenon::monitoring::monitoring_aggregator::aggregator_id_

std::string aggregator_id_

Definition monitorable_interface.h:456

Member Function Documentation

◆ add_component()

void kcenon::monitoring::monitoring_aggregator::add_component ( std::shared_ptr< monitorable_interface > component )

inline

Add a component to monitor.

Parameters

component Component to add

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 470 of file monitorable_interface.h.

                                                                       {
        if (component) {
            components_.push_back(component);
        }
    }

References components_.

Referenced by TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ clear()

void kcenon::monitoring::monitoring_aggregator::clear ( )

inline

Clear all components.

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 559 of file monitorable_interface.h.

                 {
        components_.clear();
    }

References components_.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ collect_all()

common::Result< monitoring_data > kcenon::monitoring::monitoring_aggregator::collect_all ( ) const

inline

Collect data from all components.

Returns: Aggregated monitoring data

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 498 of file monitorable_interface.h.

                                                      {
        monitoring_data aggregated(aggregator_id_);
        
        for (const auto& component : components_) {
            if (!component->is_monitoring_enabled()) {
                continue;
            }
            
            auto result = component->get_monitoring_data();
            if (result.is_ok()) {
                aggregated.merge(result.value(), component->get_monitoring_id());
            } else {
                // Log error but continue with other components
                aggregated.add_tag(
                    component->get_monitoring_id() + ".error",
                    result.error().message
                );
            }
        }
        
        // Add aggregator metadata
        aggregated.add_metric("aggregator.component_count", 
                            static_cast<double>(components_.size()));
        aggregated.add_metric("aggregator.total_metrics", 
                            static_cast<double>(aggregated.metric_count()));
        
        return common::ok(std::move(aggregated));
    }

References kcenon::monitoring::monitoring_data::add_metric(), kcenon::monitoring::monitoring_data::add_tag(), aggregator_id_, components_, kcenon::monitoring::monitoring_data::merge(), and kcenon::monitoring::monitoring_data::metric_count().

Referenced by TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_component()

std::shared_ptr< monitorable_interface > kcenon::monitoring::monitoring_aggregator::get_component ( const std::string & id ) const

inline

Get a specific component by ID.

Parameters

id	Component ID

Returns: Shared pointer to component or nullptr

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 532 of file monitorable_interface.h.

                                                                                  {
        auto it = std::find_if(components_.begin(), components_.end(),
            [&id](const auto& comp) {
                return comp->get_monitoring_id() == id;
            });
        
        return (it != components_.end()) ? *it : nullptr;
    }

References components_.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ get_component_ids()

std::vector< std::string > kcenon::monitoring::monitoring_aggregator::get_component_ids ( ) const

inline

Get all component IDs.

Returns: Vector of component identifiers

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 545 of file monitorable_interface.h.

                                                   {
        std::vector<std::string> ids;
        ids.reserve(components_.size());
        
        for (const auto& component : components_) {
            ids.push_back(component->get_monitoring_id());
        }
        
        return ids;
    }

References components_.

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ remove_component()

bool kcenon::monitoring::monitoring_aggregator::remove_component ( const std::string & id )

inline

Remove a component by ID.

Parameters

id	Component ID to remove

Returns: true if component was found and removed

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 481 of file monitorable_interface.h.

                                               {
        auto it = std::remove_if(components_.begin(), components_.end(),
            [&id](const auto& comp) {
                return comp->get_monitoring_id() == id;
            });
        
        if (it != components_.end()) {
            components_.erase(it, components_.end());
            return true;
        }
        return false;
    }

References components_.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ size()

std::size_t kcenon::monitoring::monitoring_aggregator::size ( ) const

inline

Get the number of registered components.

Returns: Component count

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 567 of file monitorable_interface.h.

                           {
        return components_.size();
    }

References components_.

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ aggregator_id_

std::string kcenon::monitoring::monitoring_aggregator::aggregator_id_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 456 of file monitorable_interface.h.

Referenced by collect_all().

◆ components_

std::vector<std::shared_ptr<monitorable_interface> > kcenon::monitoring::monitoring_aggregator::components_

private

Examples: /home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitorable_interface.h.

Definition at line 455 of file monitorable_interface.h.

Referenced by add_component(), clear(), collect_all(), get_component(), get_component_ids(), remove_component(), and size().

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

include/kcenon/monitoring/interfaces/monitorable_interface.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ monitoring_aggregator()

Member Function Documentation

◆ add_component()

◆ clear()

◆ collect_all()

◆ get_component()

◆ get_component_ids()

◆ remove_component()

◆ size()

Member Data Documentation

◆ aggregator_id_

◆ components_