kcenon::common::interfaces::health_check_result Struct Reference

Result of a health check operation. More...

#include <monitoring_interface.h>

Collaboration diagram for kcenon::common::interfaces::health_check_result:

Public Member Functions
	health_check_result ()
bool	is_healthy () const
bool	is_operational () const

Public Attributes
health_status	status = health_status::unknown
std::string	message
std::chrono::system_clock::time_point	timestamp
std::chrono::milliseconds	check_duration {0}
std::unordered_map< std::string, std::string >	metadata

Detailed Description

Result of a health check operation.

Examples

health_check_example.cpp.

Definition at line 236 of file monitoring_interface.h.

Constructor & Destructor Documentation

health_check_result()

kcenon::common::interfaces::health_check_result::health_check_result ( )

inline

Definition at line 243 of file monitoring_interface.h.

        : timestamp(std::chrono::system_clock::now()) {}

Member Function Documentation

is_healthy()

bool kcenon::common::interfaces::health_check_result::is_healthy ( ) const

inline

Definition at line 246 of file monitoring_interface.h.

                            {
        return status == health_status::healthy;
    }

References kcenon::common::interfaces::healthy, and status.

is_operational()

bool kcenon::common::interfaces::health_check_result::is_operational ( ) const

inline

Definition at line 250 of file monitoring_interface.h.

                                {
        return status == health_status::healthy ||
               status == health_status::degraded;
    }

References kcenon::common::interfaces::degraded, kcenon::common::interfaces::healthy, and status.

Member Data Documentation

check_duration

std::chrono::milliseconds kcenon::common::interfaces::health_check_result::check_duration {0}

Definition at line 240 of file monitoring_interface.h.

{0};

Referenced by kcenon::common::interfaces::composite_health_check::check().

message

std::string kcenon::common::interfaces::health_check_result::message

Examples

health_check_example.cpp.

Definition at line 238 of file monitoring_interface.h.

Referenced by app_liveness_check::check(), cache_readiness_check::check(), database_dependency_check::check(), kcenon::common::interfaces::composite_health_check::check(), kcenon::common::interfaces::lambda_health_check::check(), and kcenon::common::interfaces::health_dependency_graph::check_with_dependencies_internal().

metadata

std::unordered_map<std::string, std::string> kcenon::common::interfaces::health_check_result::metadata

Definition at line 241 of file monitoring_interface.h.

Referenced by kcenon::common::interfaces::composite_health_check::check(), and kcenon::common::interfaces::health_dependency_graph::check_with_dependencies_internal().

status

health_status kcenon::common::interfaces::health_check_result::status = health_status::unknown

Examples

health_check_example.cpp.

Definition at line 237 of file monitoring_interface.h.

Referenced by app_liveness_check::check(), cache_readiness_check::check(), database_dependency_check::check(), kcenon::common::interfaces::composite_health_check::check(), kcenon::common::interfaces::lambda_health_check::check(), kcenon::common::interfaces::health_dependency_graph::check_with_dependencies_internal(), is_healthy(), is_operational(), and kcenon::common::interfaces::health_monitor::update_stats_after_check().

timestamp

std::chrono::system_clock::time_point kcenon::common::interfaces::health_check_result::timestamp

Definition at line 239 of file monitoring_interface.h.

---

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

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