Logger System 0.1.3
High-performance C++20 thread-safe logging system with asynchronous capabilities
Loading...
Searching...
No Matches
kcenon::logger::monitoring_interface Class Referenceabstract

Abstract monitoring interface. More...

#include <monitoring_interface.h>

Inheritance diagram for kcenon::logger::monitoring_interface:
Inheritance graph
Collaboration diagram for kcenon::logger::monitoring_interface:
Collaboration graph

Public Member Functions

virtual ~monitoring_interface ()=default
 Virtual destructor.
 
virtual result< monitoring_datacollect_metrics () const =0
 Collect current metrics.
 
virtual result< health_check_resultcheck_health () const =0
 Perform health check.
 
virtual common::VoidResult reset_metrics ()=0
 Reset all metrics.
 
virtual common::VoidResult set_enabled (bool enable)=0
 Enable or disable metric collection.
 
virtual bool is_enabled () const =0
 Check if monitoring is enabled.
 
virtual std::string get_backend_name () const =0
 Get monitoring backend name.
 
virtual void increment_counter (const std::string &name, double value=1.0)=0
 Record a counter increment.
 
virtual void update_gauge (const std::string &name, double value)=0
 Update a gauge value.
 
virtual void record_histogram (const std::string &name, double value)=0
 Record a value in a histogram.
 

Detailed Description

Abstract monitoring interface.

This interface defines the contract for monitoring implementations, allowing different backends to be plugged in.

Definition at line 213 of file monitoring_interface.h.

Constructor & Destructor Documentation

◆ ~monitoring_interface()

virtual kcenon::logger::monitoring_interface::~monitoring_interface ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ check_health()

virtual result< health_check_result > kcenon::logger::monitoring_interface::check_health ( ) const
pure virtual

Perform health check.

Returns
Result containing health check result or error

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ collect_metrics()

virtual result< monitoring_data > kcenon::logger::monitoring_interface::collect_metrics ( ) const
pure virtual

Collect current metrics.

Returns
Result containing monitoring data or error

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ get_backend_name()

virtual std::string kcenon::logger::monitoring_interface::get_backend_name ( ) const
pure virtual

Get monitoring backend name.

Returns
Name of the monitoring backend

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ increment_counter()

virtual void kcenon::logger::monitoring_interface::increment_counter ( const std::string & name,
double value = 1.0 )
pure virtual

Record a counter increment.

Parameters
nameCounter name
valueIncrement value (default 1)

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ is_enabled()

virtual bool kcenon::logger::monitoring_interface::is_enabled ( ) const
pure virtual

Check if monitoring is enabled.

Returns
true if monitoring is enabled

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ record_histogram()

virtual void kcenon::logger::monitoring_interface::record_histogram ( const std::string & name,
double value )
pure virtual

Record a value in a histogram.

Parameters
nameHistogram name
valueValue to record

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ reset_metrics()

virtual common::VoidResult kcenon::logger::monitoring_interface::reset_metrics ( )
pure virtual

Reset all metrics.

Returns
Result indicating success or error

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ set_enabled()

virtual common::VoidResult kcenon::logger::monitoring_interface::set_enabled ( bool enable)
pure virtual

Enable or disable metric collection.

Parameters
enabletrue to enable, false to disable
Returns
Result indicating success or error

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.

◆ update_gauge()

virtual void kcenon::logger::monitoring_interface::update_gauge ( const std::string & name,
double value )
pure virtual

Update a gauge value.

Parameters
nameGauge name
valueNew value

Implemented in kcenon::logger::basic_monitor, and kcenon::logger::thread_system_monitor_adapter.


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