kcenon::common::interfaces::IMonitor Interface Reference

Standard interface for monitoring implementations. More...

#include <monitoring_interface.h>

Collaboration diagram for kcenon::common::interfaces::IMonitor:

Public Member Functions
virtual	~IMonitor ()=default
virtual VoidResult	record_metric (const std::string &name, double value)=0
	Record a metric value.
virtual VoidResult	record_metric (const std::string &name, double value, const std::unordered_map< std::string, std::string > &tags)=0
	Record a metric with tags.
virtual Result< metrics_snapshot >	get_metrics ()=0
	Get current metrics snapshot.
virtual Result< health_check_result >	check_health ()=0
	Perform health check.
virtual VoidResult	reset ()=0
	Reset all metrics.

Detailed Description

Standard interface for monitoring implementations.

This interface defines the contract for any monitoring implementation, allowing modules to collect metrics and check health status.

Definition at line 263 of file monitoring_interface.h.

Constructor & Destructor Documentation

~IMonitor()

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

virtualdefault

Member Function Documentation

check_health()

virtual Result< health_check_result > kcenon::common::interfaces::IMonitor::check_health ( )

pure virtual

Perform health check.

Returns

Result containing health check result or error

get_metrics()

virtual Result< metrics_snapshot > kcenon::common::interfaces::IMonitor::get_metrics ( )

pure virtual

Get current metrics snapshot.

Returns

Result containing metrics snapshot or error

record_metric() [1/2]

virtual VoidResult kcenon::common::interfaces::IMonitor::record_metric ( const std::string & name, double value )

pure virtual

Record a metric value.

Parameters

name	Metric name
value	Metric value

Returns

VoidResult indicating success or error

record_metric() [2/2]

virtual VoidResult kcenon::common::interfaces::IMonitor::record_metric ( const std::string & name, double value, const std::unordered_map< std::string, std::string > & tags )

pure virtual

Record a metric with tags.

Parameters

name	Metric name
value	Metric value
tags	Additional metadata tags

Returns

VoidResult indicating success or error

reset()

virtual VoidResult kcenon::common::interfaces::IMonitor::reset ( )

pure virtual

Reset all metrics.

Returns

VoidResult indicating success or error

---

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

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