kcenon::monitoring::metrics_collector Class Reference

Abstract base class for metric collectors. More...

#include <monitoring_core.h>

Inheritance diagram for kcenon::monitoring::metrics_collector:

Collaboration diagram for kcenon::monitoring::metrics_collector:

Public Member Functions
virtual	~metrics_collector ()=default
virtual common::Result< metrics_snapshot >	collect ()=0
	Collect metrics.
virtual std::string	get_name () const =0
	Get collector name.
virtual bool	is_enabled () const =0
	Check if collector is enabled.
virtual common::VoidResult	set_enabled (bool enable)=0
	Enable or disable the collector.
virtual common::VoidResult	initialize ()=0
	Initialize the collector.
virtual common::VoidResult	cleanup ()=0
	Cleanup collector resources.

Detailed Description

Abstract base class for metric collectors.

Base class for components that collect specific types of metrics. Collectors can be enabled/disabled and should properly initialize and cleanup their resources.

Thread Safety:

Implementations should be thread-safe. The collect() method may be called from the monitoring thread while other methods are called from configuration threads.

Definition at line 337 of file monitoring_core.h.

Constructor & Destructor Documentation

~metrics_collector()

virtual kcenon::monitoring::metrics_collector::~metrics_collector ( )

virtualdefault

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

Member Function Documentation

cleanup()

virtual common::VoidResult kcenon::monitoring::metrics_collector::cleanup ( )

pure virtual

Cleanup collector resources.

Returns

Result indicating success or cleanup error

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

collect()

virtual common::Result< metrics_snapshot > kcenon::monitoring::metrics_collector::collect ( )

pure virtual

Collect metrics.

Returns

Result containing collected metrics or error

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

Referenced by kcenon::monitoring::adaptive_collector::collect().

Here is the caller graph for this function:

get_name()

virtual std::string kcenon::monitoring::metrics_collector::get_name ( ) const

pure virtual

Get collector name.

Returns

Collector identifier

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

initialize()

virtual common::VoidResult kcenon::monitoring::metrics_collector::initialize ( )

pure virtual

Initialize the collector.

Returns

Result indicating success or initialization error

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

is_enabled()

virtual bool kcenon::monitoring::metrics_collector::is_enabled ( ) const

pure virtual

Check if collector is enabled.

Returns

true if collector is active

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

set_enabled()

virtual common::VoidResult kcenon::monitoring::metrics_collector::set_enabled ( bool enable )

pure virtual

Enable or disable the collector.

Parameters

enable

true to enable, false to disable

Returns

Result indicating success or error

Implemented in kcenon::monitoring::performance_monitor, and mock_collector.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/interfaces/monitoring_core.h.

---

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

• include/kcenon/monitoring/interfaces/monitoring_core.h