kcenon::common::interfaces::IMonitorable Interface Reference

Interface for objects that can be monitored. More...

#include <monitoring_interface.h>

Collaboration diagram for kcenon::common::interfaces::IMonitorable:

Public Member Functions
virtual	~IMonitorable ()=default
virtual Result< metrics_snapshot >	get_monitoring_data ()=0
	Get monitoring data.
virtual Result< health_check_result >	health_check ()=0
	Check health status.
virtual std::string	get_component_name () const =0
	Get component name for monitoring.

Detailed Description

Interface for objects that can be monitored.

This interface allows objects to expose their internal state for monitoring purposes.

Definition at line 313 of file monitoring_interface.h.

Constructor & Destructor Documentation

~IMonitorable()

virtual kcenon::common::interfaces::IMonitorable::~IMonitorable ( )

virtualdefault

Member Function Documentation

get_component_name()

virtual std::string kcenon::common::interfaces::IMonitorable::get_component_name ( ) const

pure virtual

Get component name for monitoring.

Returns

Component identifier

get_monitoring_data()

virtual Result< metrics_snapshot > kcenon::common::interfaces::IMonitorable::get_monitoring_data ( )

pure virtual

Get monitoring data.

Returns

Result containing metrics snapshot or error

health_check()

virtual Result< health_check_result > kcenon::common::interfaces::IMonitorable::health_check ( )

pure virtual

Check health status.

Returns

Result containing health check result or error

---

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

• include/kcenon/common/interfaces/monitoring_interface.h