Error boundary implementation for resilient operations. More...

#include <error_boundary.h>

Collaboration diagram for kcenon::monitoring::error_boundary< T >:

Public Types
using	config = error_boundary_config

Public Member Functions
	error_boundary ()

	error_boundary (const std::string &name)

	error_boundary (const std::string &name, const config &cfg)

template<typename Func >
auto	execute (Func &&func) -> common::Result< T >
	Execute a function within the error boundary.

template<typename Func , typename FallbackFunc >
auto	execute (Func &&func, FallbackFunc &&fallback) -> common::Result< T >
	Execute with custom fallback function.

void	set_error_handler (std::function< void(const error_info &, degradation_level)> handler)
	Set error handler callback.

void	set_fallback_strategy (std::shared_ptr< fallback_strategy_interface< T > > strategy)
	Set fallback strategy.

degradation_level	get_degradation_level () const
	Get current degradation level.

void	force_degradation (degradation_level level)
	Force degradation to a specific level.

common::Result< bool >	is_healthy () const
	Check if the boundary is healthy.

error_boundary_metrics	get_metrics () const
	Get metrics.

const std::string &	get_name () const
	Get boundary name.

Private Member Functions
common::Result< T >	handle_failure (const common::error_info &err)

void	handle_success ()

void	upgrade_degradation ()

void	downgrade_degradation ()

Private Attributes
std::string	name_

config	config_

std::function< void(const error_info &, degradation_level)>	error_handler_

std::shared_ptr< fallback_strategy_interface< T > >	fallback_strategy_

error_boundary_metrics	metrics_

degradation_level	current_degradation_level_ = degradation_level::normal

size_t	consecutive_failures_ = 0

Detailed Description

template<typename T>
class kcenon::monitoring::error_boundary< T >

Error boundary implementation for resilient operations.

Examples: health_reliability_example.cpp.

Definition at line 198 of file error_boundary.h.

Member Typedef Documentation

◆ config

template<typename T >

using kcenon::monitoring::error_boundary< T >::config = error_boundary_config

Definition at line 200 of file error_boundary.h.

Constructor & Destructor Documentation

◆ error_boundary() [1/3]

template<typename T >

kcenon::monitoring::error_boundary< T >::error_boundary ( )

inline

Definition at line 202 of file error_boundary.h.

202: name_("default"), config_() {}

kcenon::monitoring::error_boundary::name_

std::string name_

Definition error_boundary.h:385

kcenon::monitoring::error_boundary::config_

config config_

Definition error_boundary.h:386

◆ error_boundary() [2/3]

template<typename T >

kcenon::monitoring::error_boundary< T >::error_boundary ( const std::string & name )

inlineexplicit

Definition at line 204 of file error_boundary.h.

                                                   : name_(name), config_() {
        config_.name = name;
    }

References kcenon::monitoring::error_boundary< T >::config_, and kcenon::monitoring::error_boundary_config::name.

◆ error_boundary() [3/3]

template<typename T >

kcenon::monitoring::error_boundary< T >::error_boundary	(	const std::string &	name,
		const config &	cfg )

inlineexplicit

Definition at line 208 of file error_boundary.h.

        : name_(name), config_(cfg) {
        config_.name = name;
    }

References kcenon::monitoring::error_boundary< T >::config_, and kcenon::monitoring::error_boundary_config::name.

Member Function Documentation

◆ downgrade_degradation()

template<typename T >

void kcenon::monitoring::error_boundary< T >::downgrade_degradation ( )

inlineprivate

Definition at line 378 of file error_boundary.h.

                                 {
        auto current = static_cast<int>(current_degradation_level_);
        if (current > 0) {
            current_degradation_level_ = static_cast<degradation_level>(current - 1);
        }
    }

References kcenon::monitoring::error_boundary< T >::current_degradation_level_.

Referenced by kcenon::monitoring::error_boundary< T >::handle_success().

Here is the caller graph for this function:

◆ execute() [1/2]

template<typename T >

template<typename Func >

auto kcenon::monitoring::error_boundary< T >::execute ( Func && func ) -> common::Result<T>

inline

Execute a function within the error boundary.

Definition at line 217 of file error_boundary.h.

                                                 {
        metrics_.total_operations++;
 
        try {
            auto op_result = func();
 
            if (op_result.is_ok()) {
                metrics_.successful_operations++;
                handle_success();
                return op_result;
            }
 
            metrics_.failed_operations++;
            return handle_failure(op_result.error());
 
        } catch (const std::exception& e) {
            metrics_.failed_operations++;
            error_info err(monitoring_error_code::operation_failed, e.what());
            return handle_failure(err.to_common_error());
        } catch (...) {
            metrics_.failed_operations++;
            error_info err(monitoring_error_code::operation_failed, "Unknown exception");
            return handle_failure(err.to_common_error());
        }
    }

References kcenon::monitoring::error_boundary_metrics::failed_operations, kcenon::monitoring::error_boundary< T >::handle_failure(), kcenon::monitoring::error_boundary< T >::handle_success(), kcenon::monitoring::error_boundary< T >::metrics_, kcenon::monitoring::operation_failed, kcenon::monitoring::error_boundary_metrics::successful_operations, kcenon::monitoring::error_info::to_common_error(), and kcenon::monitoring::error_boundary_metrics::total_operations.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute() [2/2]

template<typename T >

template<typename Func , typename FallbackFunc >

auto kcenon::monitoring::error_boundary< T >::execute	(	Func &&	func,
		FallbackFunc &&	fallback ) -> common::Result<T>

inline

Execute with custom fallback function.

Definition at line 247 of file error_boundary.h.

                                                                          {
        metrics_.total_operations++;
 
        try {
            auto op_result = func();
 
            if (op_result.is_ok()) {
                metrics_.successful_operations++;
                handle_success();
                return op_result;
            }
 
            metrics_.failed_operations++;
            error_info err = error_info::from_common_error(op_result.error());
            return fallback(err, current_degradation_level_);
 
        } catch (const std::exception& e) {
            metrics_.failed_operations++;
            error_info err(monitoring_error_code::operation_failed, e.what());
            return fallback(err, current_degradation_level_);
        }
    }

Here is the call graph for this function:

◆ force_degradation()

template<typename T >

void kcenon::monitoring::error_boundary< T >::force_degradation ( degradation_level level )

inline

Force degradation to a specific level.

Definition at line 294 of file error_boundary.h.

                                                    {
        if (level <= config_.max_degradation) {
            current_degradation_level_ = level;
        }
    }

References kcenon::monitoring::error_boundary< T >::config_, kcenon::monitoring::error_boundary< T >::current_degradation_level_, and kcenon::monitoring::error_boundary_config::max_degradation.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ get_degradation_level()

template<typename T >

degradation_level kcenon::monitoring::error_boundary< T >::get_degradation_level ( ) const

inline

Get current degradation level.

Definition at line 287 of file error_boundary.h.

                                                    {
        return current_degradation_level_;
    }

References kcenon::monitoring::error_boundary< T >::current_degradation_level_.

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

Here is the caller graph for this function:

◆ get_metrics()

template<typename T >

error_boundary_metrics kcenon::monitoring::error_boundary< T >::get_metrics ( ) const

inline

Get metrics.

Definition at line 311 of file error_boundary.h.

                                               {
        return metrics_;
    }

References kcenon::monitoring::error_boundary< T >::metrics_.

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

Here is the caller graph for this function:

◆ get_name()

template<typename T >

const std::string & kcenon::monitoring::error_boundary< T >::get_name ( ) const

inline

Get boundary name.

Definition at line 318 of file error_boundary.h.

                                      {
        return name_;
    }

References kcenon::monitoring::error_boundary< T >::name_.

◆ handle_failure()

template<typename T >

common::Result< T > kcenon::monitoring::error_boundary< T >::handle_failure ( const common::error_info & err )

inlineprivate

Definition at line 323 of file error_boundary.h.

                                                                {
        consecutive_failures_++;
 
        // Check if we should degrade
        if (config_.policy == error_boundary_policy::degrade &&
            consecutive_failures_ >= config_.error_threshold) {
            upgrade_degradation();
        }
 
        // Call error handler if set
        if (error_handler_) {
            error_info monitoring_err = error_info::from_common_error(err);
            error_handler_(monitoring_err, current_degradation_level_);
        }
 
        // Apply policy
        switch (config_.policy) {
            case error_boundary_policy::fail_fast:
                return common::Result<T>::err(err);
 
            case error_boundary_policy::isolate:
                return common::Result<T>::err(error_info(monitoring_error_code::service_degraded, "Service isolated due to error").to_common_error());
 
            case error_boundary_policy::fallback:
                if (fallback_strategy_) {
                    error_info monitoring_err = error_info::from_common_error(err);
                    return fallback_strategy_->get_fallback(monitoring_err, current_degradation_level_);
                }
                return common::Result<T>::err(err);
 
            case error_boundary_policy::degrade:
            default:
                return common::Result<T>::err(err);
        }
    }

Referenced by kcenon::monitoring::error_boundary< T >::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handle_success()

template<typename T >

void kcenon::monitoring::error_boundary< T >::handle_success ( )

inlineprivate

Definition at line 359 of file error_boundary.h.

                          {
        consecutive_failures_ = 0;
 
        // Check for recovery
        if (config_.enable_automatic_recovery &&
            current_degradation_level_ != degradation_level::normal) {
            metrics_.recovery_attempts++;
            downgrade_degradation();
        }
    }

References kcenon::monitoring::error_boundary< T >::config_, kcenon::monitoring::error_boundary< T >::consecutive_failures_, kcenon::monitoring::error_boundary< T >::current_degradation_level_, kcenon::monitoring::error_boundary< T >::downgrade_degradation(), kcenon::monitoring::error_boundary_config::enable_automatic_recovery, kcenon::monitoring::error_boundary< T >::metrics_, kcenon::monitoring::normal, and kcenon::monitoring::error_boundary_metrics::recovery_attempts.

Referenced by kcenon::monitoring::error_boundary< T >::execute(), and kcenon::monitoring::error_boundary< T >::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_healthy()

template<typename T >

common::Result< bool > kcenon::monitoring::error_boundary< T >::is_healthy ( ) const

inline

Check if the boundary is healthy.

Definition at line 303 of file error_boundary.h.

                                          {
        bool healthy = (current_degradation_level_ == degradation_level::normal);
        return common::ok(healthy);
    }

References kcenon::monitoring::error_boundary< T >::current_degradation_level_, kcenon::monitoring::healthy, and kcenon::monitoring::normal.

Referenced by TEST_F().

Here is the caller graph for this function:

◆ set_error_handler()

template<typename T >

void kcenon::monitoring::error_boundary< T >::set_error_handler ( std::function< void(const error_info &, degradation_level)> handler )

inline

Set error handler callback.

Definition at line 273 of file error_boundary.h.

                                                                                            {
        error_handler_ = std::move(handler);
    }

References kcenon::monitoring::error_boundary< T >::error_handler_.

Referenced by demonstrate_error_boundaries().

Here is the caller graph for this function:

◆ set_fallback_strategy()

template<typename T >

void kcenon::monitoring::error_boundary< T >::set_fallback_strategy ( std::shared_ptr< fallback_strategy_interface< T > > strategy )

inline

Set fallback strategy.

Definition at line 280 of file error_boundary.h.

                                                                                       {
        fallback_strategy_ = std::move(strategy);
    }

References kcenon::monitoring::error_boundary< T >::fallback_strategy_.

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

Here is the caller graph for this function:

◆ upgrade_degradation()

template<typename T >

void kcenon::monitoring::error_boundary< T >::upgrade_degradation ( )

inlineprivate

Definition at line 370 of file error_boundary.h.

                               {
        auto current = static_cast<int>(current_degradation_level_);
        auto max_level = static_cast<int>(config_.max_degradation);
        if (current < max_level) {
            current_degradation_level_ = static_cast<degradation_level>(current + 1);
        }
    }

References kcenon::monitoring::error_boundary< T >::config_, kcenon::monitoring::error_boundary< T >::current_degradation_level_, and kcenon::monitoring::error_boundary_config::max_degradation.

Referenced by kcenon::monitoring::error_boundary< T >::handle_failure().

Here is the caller graph for this function:

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

include/kcenon/monitoring/reliability/error_boundary.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ config

Constructor & Destructor Documentation

◆ error_boundary() [1/3]

◆ error_boundary() [2/3]

◆ error_boundary() [3/3]

Member Function Documentation

◆ downgrade_degradation()

◆ execute() [1/2]

◆ execute() [2/2]

◆ force_degradation()

◆ get_degradation_level()

◆ get_metrics()

◆ get_name()

◆ handle_failure()

◆ handle_success()

◆ is_healthy()

◆ set_error_handler()

◆ set_fallback_strategy()

◆ upgrade_degradation()

Member Data Documentation

◆ config_

◆ consecutive_failures_

◆ current_degradation_level_

◆ error_handler_

◆ fallback_strategy_

◆ metrics_

◆ name_