Health Monitor Visualization

The system health status can be visualized in DataStudio or using external apps like Visual KPI or WebStudio. Reports are automatically generated and can be exported in a variety of common file formats. This document briefly addresses these possibilities, focussing on the automated procedures for Visual KPI and reports.

Displaying the Health Monitor KPIs in Visual KPI

With the KPI Model Automation property enabled and the KPI property correctly configured, the system will provide a number of preconfigured Dashboards for Visual KPI.

  1. To access these, in the top right-hand corner of the Visual KPI browser window, click on the profile icon in the top right corner and select 'Default (Change Profile)'.

    Changing the Profile in Visual KPI
    Figure 1. Changing the Profile in Visual KPI
  2. In the Change Profile dialog, select the KPI Profile Group from the path configured in the Health Monitor object’s KPI Server Profile property.

  3. Then, select the KPI Server Profile from the Profile drop-down list and click Select to confirm.

    Profile Group and Profile Selected
    Figure 2. Profile Group and Profile selected
  4. To select a dashboard, click on the Dashboards icon next to the profile icon to expand the list. The available options correspond to the Dashboard objects which have been generated in the Server Model when the Health Monitor was initialized.

    Selecting a Different Dashboard
    Figure 3. Selecting a different Dashboard

WebStudio

In WebStudio, a similar (or completely different) presentation of the health status of the system can be achieved using Faceplate and Chart widgets in a Compilation.

Displaying Health Monitor KPIs in WebStudio
Figure 4. Displaying Health Monitor KPIs in WebStudio

The Health Monitor Dashboard

Webstudio also comes with a built-in dashboard for the Health Monitor. To open this dashboard, open the following URL in your browser, adjusting <hostname_webapi> and <port> to your situation.

http://<hostname_webapi>:<port>/apps/webstudio/?hostname=<hostname_webapi>&port=<port>&lib=syslib.app-webstudio-healthmonitor&func=dashboard_compilation

DataStudio

In DataStudio, the System Health status can be visualized using the Dashboard Display in conjunction with History Trend Displays.

System Health KPIs in Datastudio
Figure 5. System Health KPIs in DataStudio

Automatic Report Generation

The easiest way to view the Report created by the Health Monitor, is to use DataStudio’s Dashboard Display.

  1. To Open the Dashboard display in DataStudio, select 'Dashboard' from the Open or press Ctrl+D on the keyboard.

  2. Then select the 'Health Monitor Report' object in the I/O Model and - keeping the left mouse button pressed - drag and drop the Report onto the Dashboard display.

    Drag-and-Drop the Report to the Dashboard Dislay
    Figure 6. Drag-and-Drop the Report to the Dashboard Display
  3. To see the full report, right-click on the Report in the Dashboard and select Report Template  Report from the context menu. The initial view shows the Header.

    The Health Monitor Report Context Menu - Selecting the Report Template
    Figure 7. The Health Monitor Report Context Menu - Selecting the Report Template

In the context menu, the Layout can also be controlled and the Report can be exported to various file formats.

The Health Monitor Report in the Dashboard Display
Figure 8. The Health Monitor Report in the Dashboard Display
In the Dashboard, the displayed Health Monitor Report is refreshed each time the Health Monitor is executed. This frequency can be configured in the Execution Period property in the Options section of the Health Monitor object’s properties.