kcenon::thread::diagnostics::component_health Struct Reference

Health status of a single component. More...

#include <health_status.h>

Collaboration diagram for kcenon::thread::diagnostics::component_health:

Public Member Functions
auto	is_operational () const -> bool
	Checks if this component is operational.

Public Attributes
std::string	name
	Name of the component (e.g., "workers", "queue", "metrics").
health_state	state {health_state::unknown}
	Current health state of this component.
std::string	message
	Human-readable message describing the current state.
std::map< std::string, std::string >	details
	Additional details about this component's health.

Detailed Description

Health status of a single component.

Represents the health of a single subsystem or component within the thread pool (e.g., workers, queue, metrics).

Definition at line 143 of file health_status.h.

Member Function Documentation

is_operational()

auto kcenon::thread::diagnostics::component_health::is_operational ( ) const -> bool

inlinenodiscard

Checks if this component is operational.

Returns

true if healthy or degraded.

Definition at line 171 of file health_status.h.

        {
            return state == health_state::healthy ||
                   state == health_state::degraded;
        }

References kcenon::thread::diagnostics::degraded, kcenon::thread::diagnostics::healthy, and state.

Member Data Documentation

details

std::map<std::string, std::string> kcenon::thread::diagnostics::component_health::details

Additional details about this component's health.

Key-value pairs with component-specific metrics or information.

Definition at line 165 of file health_status.h.

Referenced by kcenon::thread::diagnostics::thread_pool_diagnostics::check_metrics_health(), kcenon::thread::diagnostics::thread_pool_diagnostics::check_queue_health(), and kcenon::thread::diagnostics::thread_pool_diagnostics::check_worker_health().

message

std::string kcenon::thread::diagnostics::component_health::message

Human-readable message describing the current state.

Definition at line 158 of file health_status.h.

Referenced by kcenon::thread::diagnostics::thread_pool_diagnostics::check_metrics_health(), kcenon::thread::diagnostics::thread_pool_diagnostics::check_queue_health(), and kcenon::thread::diagnostics::thread_pool_diagnostics::check_worker_health().

name

std::string kcenon::thread::diagnostics::component_health::name

Name of the component (e.g., "workers", "queue", "metrics").

Definition at line 148 of file health_status.h.

Referenced by kcenon::thread::diagnostics::thread_pool_diagnostics::check_metrics_health(), kcenon::thread::diagnostics::thread_pool_diagnostics::check_queue_health(), and kcenon::thread::diagnostics::thread_pool_diagnostics::check_worker_health().

state

health_state kcenon::thread::diagnostics::component_health::state {health_state::unknown}

Current health state of this component.

Definition at line 153 of file health_status.h.

{health_state::unknown};

Referenced by kcenon::thread::diagnostics::thread_pool_diagnostics::check_metrics_health(), kcenon::thread::diagnostics::thread_pool_diagnostics::check_queue_health(), kcenon::thread::diagnostics::thread_pool_diagnostics::check_worker_health(), and is_operational().

---

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

• include/kcenon/thread/diagnostics/health_status.h