Data Structures
struct	dwHealthKeyValue
	Defines a pair of a key and value used to provide additional debugging information to the dwHealthSignal. More...

struct	dwHealthSignal
	Basic health signal that describes the health status of a particular software element. More...

struct	dwHealthSignalArray
	Represents an array of health signals which are grouped together as one structure. More...

Macros
#define	DW_MAX_HEALTH_KEY_VALUE_PAIRS 16

#define	DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64

#define	DW_MAX_MESSAGE_LENGTH 32

Enumerations
enum	dwHealthState { HEALTH_STATE_UNKNOWN = 0, HEALTH_STATE_OK = 3, HEALTH_STATE_WARN = 5, HEALTH_STATE_ERROR = 6 }
	Enumerated levels of health describing health status. More...

enum	dwSeverityLevel { SEVERITY_LEVEL_UNKNOWN = 0, SEVERITY_LEVEL_LOW = 3, SEVERITY_LEVEL_MEDIUM = 5, SEVERITY_LEVEL_HIGH = 6, SEVERITY_LEVEL_CRITICAL = 9 }
	Enumerated levels of severity describing the consequence of health signal on the entire system. More...

Data Structure Documentation

◆ dwHealthKeyValue

struct dwHealthKeyValue

Data Fields
char	key[DW_MAX_MESSAGE_LENGTH]	Describes the information that the `value` represents.
char	value[DW_MAX_MESSAGE_LENGTH]	Debug information related to the health signal.

struct dwHealthSignal

Data Fields
uint32_t	age	Represents the time (number of cycles of the source generating the signal) since the last id change.
uint32_t	errorCode	Defines the code of health failure being reported.
dwHealthState	healthState
uint64_t	id	Represents an ID for the current health state and will change whenever a new health state is reported. Small fluctuations in score should not force an ID change.
uint32_t	nValues	Number of key value pairs defined in the field `values` below.
uint8_t	score	In range [0,255] where 0 implies critically unhealthy and 255 implies completely healthy. Redundant to dwHealthState, consumer can choose what to use.
dwSeverityLevel	severityLevel
uint32_t	sourceID	Defines the source of the health signal.
dwTime_t	timestamp
dwHealthKeyValue	values[DW_MAX_HEALTH_KEY_VALUE_PAIRS]	Optional array of key value pairs used to provide extra information about the health signal.

struct dwHealthSignalArray

Data Fields
uint32_t	count
dwHealthSignal	signal[DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE]

#define DW_MAX_HEALTH_KEY_VALUE_PAIRS 16

Definition at line 66 of file HealthSignals.h.

#define DW_MAX_HEALTH_SIGNAL_ARRAY_SIZE 64

Definition at line 105 of file HealthSignals.h.

#define DW_MAX_MESSAGE_LENGTH 32

Definition at line 65 of file HealthSignals.h.

Enumerated levels of health describing health status.

Definition at line 46 of file HealthSignals.h.

Enumerated levels of severity describing the consequence of health signal on the entire system.

Note: Not all SOFTWARE_ELEMENTs will have this context so it may be described as SEVERITY_LEVEL_UNKNOWN.

Definition at line 57 of file HealthSignals.h.