The "sessionHealth" property is a required enumerated string that describes the session health. It has the following values: "healthy", "unhealthy", and "offline":
-
"healthy"indicates the session is healthy, which occurs when a client is:- Connected
- Sends at least the expected number of messages per minute (see
"minHealthySendRatePerMinute"). - Sends less than or equal to the maximum number of messages per minute (see
"maxHealthySendRatePerMinute"). - Does not exceed the maximum backlog rate of unprocessed subscribed messages (see
"maxHealthyBacklogRatePerMinute"). - Subscribes to at least the minimum expected number of topic filters ( see
"minHealthySubscribedTopicFiltersCount"). - Subscribes to no more than the maximum number of expected number of topic filters (see
"maxHealthySubscribedTopicFiltersCount").
-
"unhealthy"indicates the session is unhealthy, which occurs when a client:- Fails to send the expected number of messages per minute (see
"minHealthySendRatePerMinute"). - Sends more than the maximum number of messages per minute (see
"maxHealthySendRatePerMinute"). - Exceeds the maximum backlog of unprocessed subscribed messages (see
"maxHealthyBacklogRatePerMinute"). - Subscribes to less than the minimum number of expected number of topic filters ( see
"minHealthySubscribedTopicFiltersCount"). - Subscribes to more than the maximum number of expected number of topic filters (see
"maxHealthySubscribedTopicFiltersCount").
- Fails to send the expected number of messages per minute (see
-
"offline"indicates a session is not connected.
The server excludes a metric from the calculation when it is set to the default value of 0.
The session health properties include:
"minHealthySendRatePerMinute""maxHealthySendRatePerMinute""maxHealthyBacklogRatePerMinute""minHealthySubscribedTopicFiltersCount"“maxHealthySubscribedTopicFiltersCount”