external_api_health_check Class Reference

Inheritance diagram for external_api_health_check:

Collaboration diagram for external_api_health_check:

Public Member Functions
	external_api_health_check (const std::string &name)
std::string	get_name () const override
	Get the human-readable name of this health check.
health_check_type	get_type () const override
	Get the type of this health check (liveness, readiness, or startup).
health_check_result	check () override
	Execute the health check and return the result.
bool	is_critical () const override
	Whether this check is critical for overall system health.
Public Member Functions inherited from kcenon::monitoring::health_check
virtual	~health_check ()=default
virtual std::chrono::milliseconds	get_timeout () const
	Get the maximum time allowed for this check to complete.

Private Attributes
std::string	name_

Detailed Description

Examples

production_monitoring_example.cpp.

Definition at line 71 of file production_monitoring_example.cpp.

Constructor & Destructor Documentation

external_api_health_check()

external_api_health_check::external_api_health_check ( const std::string & name )

inlineexplicit

Examples

production_monitoring_example.cpp.

Definition at line 76 of file production_monitoring_example.cpp.

: name_(name) {}

Member Function Documentation

check()

health_check_result external_api_health_check::check ( )

inlineoverridevirtual

Execute the health check and return the result.

Returns

A health_check_result indicating the current health status

Implements kcenon::monitoring::health_check.

Examples

production_monitoring_example.cpp.

Definition at line 86 of file production_monitoring_example.cpp.

                                         {
        // Simulate external API health check
        return health_check_result::healthy("External API responding");
    }

References kcenon::monitoring::health_check_result::healthy().

Here is the call graph for this function:

get_name()

std::string external_api_health_check::get_name ( ) const

inlineoverridevirtual

Get the human-readable name of this health check.

Returns

The health check name

Implements kcenon::monitoring::health_check.

Examples

production_monitoring_example.cpp.

Definition at line 78 of file production_monitoring_example.cpp.

                                        {
        return name_;
    }

References name_.

get_type()

health_check_type external_api_health_check::get_type ( ) const

inlineoverridevirtual

Get the type of this health check (liveness, readiness, or startup).

Returns

The health check type

Implements kcenon::monitoring::health_check.

Examples

production_monitoring_example.cpp.

Definition at line 82 of file production_monitoring_example.cpp.

                                                {
        return health_check_type::readiness;
    }

is_critical()

bool external_api_health_check::is_critical ( ) const

inlineoverridevirtual

Whether this check is critical for overall system health.

Returns

true if failure of this check should mark the system as unhealthy (default: false)

Reimplemented from kcenon::monitoring::health_check.

Examples

production_monitoring_example.cpp.

Definition at line 91 of file production_monitoring_example.cpp.

                                      {
        return false;
    }

Member Data Documentation

name_

std::string external_api_health_check::name_

private

Examples

production_monitoring_example.cpp.

Definition at line 73 of file production_monitoring_example.cpp.

Referenced by get_name().

---

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

• examples/production_monitoring_example.cpp