kcenon::pacs::monitoring::health_check_result Struct Reference

Result of a health check operation. More...

#include <pacs_monitor.h>

Collaboration diagram for kcenon::pacs::monitoring::health_check_result:

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

Public Attributes
monitor_health_status	status {monitor_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.

Definition at line 131 of file pacs_monitor.h.

Constructor & Destructor Documentation

health_check_result()

kcenon::pacs::monitoring::health_check_result::health_check_result ( )

inline

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 138 of file pacs_monitor.h.

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

Member Function Documentation

is_healthy()

bool kcenon::pacs::monitoring::health_check_result::is_healthy ( ) const

inlinenodiscard

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 141 of file pacs_monitor.h.

                                          {
        return status == monitor_health_status::healthy;
    }

References kcenon::pacs::monitoring::healthy, and status.

is_operational()

bool kcenon::pacs::monitoring::health_check_result::is_operational ( ) const

inlinenodiscard

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 145 of file pacs_monitor.h.

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

References kcenon::pacs::monitoring::degraded, kcenon::pacs::monitoring::healthy, and status.

Member Data Documentation

check_duration

std::chrono::milliseconds kcenon::pacs::monitoring::health_check_result::check_duration {0}

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 135 of file pacs_monitor.h.

{0};

Referenced by kcenon::pacs::monitoring::pacs_monitor::check_health().

message

std::string kcenon::pacs::monitoring::health_check_result::message

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 133 of file pacs_monitor.h.

Referenced by kcenon::pacs::monitoring::pacs_monitor::check_health().

metadata

std::unordered_map<std::string, std::string> kcenon::pacs::monitoring::health_check_result::metadata

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 136 of file pacs_monitor.h.

Referenced by kcenon::pacs::monitoring::pacs_monitor::check_health().

status

monitor_health_status kcenon::pacs::monitoring::health_check_result::status {monitor_health_status::unknown}

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 132 of file pacs_monitor.h.

{monitor_health_status::unknown};

Referenced by kcenon::pacs::monitoring::pacs_monitor::check_health(), is_healthy(), and is_operational().

timestamp

std::chrono::system_clock::time_point kcenon::pacs::monitoring::health_check_result::timestamp

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/pacs_monitor.h.

Definition at line 134 of file pacs_monitor.h.

---

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

• include/kcenon/pacs/monitoring/pacs_monitor.h