Visualizing System Health on the Monitoring Dashboard

The monitoring dashboard displays real-time information on system health for process definitions, action work, secure gateways, and a number of process servers and queues. The dashboard has the following tabs:

1. Overview - displays all monitors.
2. System Health - displays process server, queue, and action work monitors.
3. Schedule Health - displays all process-related monitors.

System Health

System health monitors display the status of process servers, queues, and action work (action work is performed for process actions, triggers, time window calculations, for example).

You select process servers and queues to be monitored by checking the Monitor On Dashboard property.

• A queue that is either held or closed (not served by any running process servers), will be counted towards the action items.
• A process server that is shutdown will count towards the action items.
• Action work is counted as concurrent action workers; by default, 50 to 74 concurrent action workers will cause the monitor to turn orange, 75 or more red.

Schedule Health

Schedule Health monitors display problematic processes:

• ActiveJobGroups - Active process schedules without currently scheduled processes
• MissingSchedules - Process groups that have a specific number of processes that missed their schedule (default 1)
• NotCurrentMaster - processes that are not using the latest version of the process definition
• ActionRequired - processes that have been in a state requiring manual intervention for a specific duration (default 1 day)
• DelayedInRemoteSystem - processes that have been delayed in a remote system for a specific duration (default 1 minute)
• EventWait - processes that have been in EventWait for a specific duration (default 7 days)
• IntermediateStates - processes that have been in intermediate states for a specific duration (default 20 seconds)
• LockWait - processes that have been in LockWait for a specific duration (default 1 hour)
• LongRunningAction - processes that have been subject to long running actions or triggers (default 1 minute)
• LongRuntime - processes that have been running for specific duration (default 1 day)
• StartDelay - processes that have seen their start delayed by a specific duration (default 20 seconds)

Documentation

Each item has its own configurable documentation stored in documents DashboardHelp_<item>.

System Health Configuration

Monitor	Default
ActionWork	Red=75, Orange=50

Schedule Health Configuration

Monitor	Default	Range
ActiveJobGroups	1	Min: 1 Max: 1000
MissingSchedules	1	Min: 1 Max: 1000
NotCurrentMaster	1	Min: 1 Max: 1000
ActionRequired	1d	Min: 1h Max: 30d
DelayedInRemoteSystem	60s	Min: 1s Max: 1d
EventWait	7d	Min: 1h Max: 30d
IntermediateStates	20s	Min: 1s Max: 1d
LockWait	1h	Min: 1s Max: 1d
LongRunningAction	60s	Min: 1s Max: 1d
LongRuntime	1d	Min: 1h Max: 30d
StartDelay	20s	Min: 1s Max: 1d

Custom Health Configuration

Custom health allows you to monitor objects using filters. The filter defines which objects to monitor, custom health allows you to set thresholds for Red and Orange severity.

To enable custom health monitors you set the following registry entry to true:

/configuration/jcs/monitoringdashboard/customhealth/enabled

The registry entry allows you to monitor filters on the monitoring dashboard.

Procedure

1. Ensure /configuration/jcs/monitoringdashboard/customhealth/enabled registry entry is set to true.
   1. Navigate to Configuration > Registry.
   2. Navigate to /configuration/jcs/monitoringdashboard/customhealth/enabled, if the path does not exist, choose New Registry by path, fill /configuration/jcs/monitoringdashboard/customhealth/enabled into the Path field, and true into the Value field. Choose Save & Close.
2. Navigate to an overview (for example Monitoring > Processes or Monitoring > Events)
3. Choose Filter > New Filter from the context-menu.
4. Specify a name for the filter, select Monitor on Dashboard; this option is only displayed if the customhealth registry entry is set to true.
5. Select the criteria for the filter.
6. Choose Save & Close.
7. Navigate to Monitoring > Monitoring Dashboard.
8. Choose the [i] button and choose Global Configuration, locate the Custom Health Configuration section below, set a value for for Red and for Orange; choose Save.
9. Choose the [i] button and choose User Configuration, locate the Custom Health Configuration section below, drag the monitor <object> - <name_of_created_filter> from the Available column to the Selected column, and choose Save.
10. The new monitor is available on the Custom Health tab.

Example

A number of resource intensive processes run in a specific queue; the process server serving the queue can handle only 6 concurrent processes and you would like to monitor activity in the queue.

1. Navigate to Monitoring > Processes.
2. Choose Filter > New Filter from the context-menu.
3. Specify a name for the filter, select Monitor on Dashboard.
4. Select Where the process is in Queue, choose Queue in the detail pane, and add the queue.
5. Select where the process has Status, choose Status in the detail pane, and select Running.
6. Choose Save & Close.
7. Navigate to Monitoring > Monitoring Dashboard.
8. Choose the [i] button and choose Global Configuration, locate the Custom Health Configuration section below, set 6 for Red and 4 for Orange; choose Save.
9. Choose the [i] button and choose User Configuration, locate the Custom Health Configuration section below, drag the monitor Process - <name_of_created_filter> from the Available column to the Selected column, and choose Save.
10. The new monitor is available on the Custom Health tab.

See Also

• Privileges Required for using the Monitoring Dashboard