Health Monitor Setup

This page provides a detailed description of how to set up the Health Monitor in DataStudio using manual configuration.

The Health Monitor can also be configured automatically. To do this, right-click on the Core object in the I/O Model and select Admin  Advanced Functions  Create Health Monitor. As well as the Health Monitor itself, a 'Health Monitoring' folder will be creted under each Component object (i.e. Local Core, Connector, Relay). Using the automatic configuration will activate the Health Monitor when created.
When Visual KPI is to be used in conjunction with the Health Monitor, some fine-tuning is required. Please see the Health Monitor Userview.

If you intend to display the Health Monitor’s KPIs on a screen in addition to reports, one configuration step has to be made in the KPI Model. Adding the KPI functionality later is no problem but for the sake of linear configuration process, it’s best to prepare the KPI Model before installing the Health Monitor.

Preparing the KPI Model

  1. In the Model Panel, select the KPI Model.

  2. In the KPI Model display, right-click on the empty space and select New  Enterprise.

  3. In the Create Object wizard, provide a name and an optional description. Then click Create.

    Creating a New Enterprise Object for the Health Monitor
    Figure 1. Creating a new Enterprise object for the Health Monitor
If you intend to use Visual KPI to display the Health Monitor’s KPIs, it needs to be installed. The Installing Visual KPI Jumpstart provides step-by-step instructions.
The system can automatically create a number of VisualKPI Dashboards for the Health Monitor. For this feature, the system needs to have a KPI Server installed and running as well as a KPI Profile Group and KPI Profile configured in the Access Model.

Installing the Health Monitor

A number of folders (containing objects) will be generated as siblings of the Health Monitor Object. To keep them in one place, it’s strongly suggested to create a specific folder underneath the Master Core object, dedicated to Health Monitoring. The Health Monitor works system-wide, therefore, it is configured on Master Core level.

  1. In the I/O Model, select the Master Core object and right-click on it. From the context menu, select Admin  New  Data Processing  Folder.

  2. In the Create Object wizard, give the new Folder object a suitable name, e.g. 'Health Monitor Folder' and click Create.

  3. Select this newly created Folder object and right-click to open its context menu.

  4. Select Admin  New  System Monitoring  Health Monitor.

  5. In the Create Object wizard, give the new object a suitable name, e.g. 'Health Monitor' and provide an optional description.

    The Common Section of the Create Health Monitor Wizard
    Figure 2. The Common section of the Create Health Monitor Wizard
  6. Click Next to proceed to the Options section.

  7. Find the KPI Model Base Path property and click its …​ button.

    Opening the KPI Model Object Picker
    Figure 3. Opening the KPI Model Object Picker
  8. From the Edit KPI Model Base Path dialog, select the 'Health Monitor Enterprise' created in preparation for the Health Monitor object, and click OK

    Picking the KPI Model Base Path Object
    Figure 4. Picking the KPI Model Base Path Object
  9. Click the …​ button on the KPI Server Profile property.

  10. In the Edit KPI Server Profile dialog, select a KPI Server Profile and click OK.

    Picking the KPI Server Profile
    Figure 5. Picking the KPI Server Profile
  11. Then click Create to create the new Health Monitor Object.

    The Options Section configured
    Figure 6. The Options Section configured

Initializing the Health Monitor

The Health Monitor will be initialized on its activation.

  1. To activate the Health Monitor, select the object in the I/O Model and in the Properties Panel, go to the Common section.

    If the Health Monitor was created from the context menu using Admin  Advanced Functions  Create Health Monitor, it will automatically be activated
  2. Set Processing Mode to 'Active' and click Apply.

    Activating the Health Monitor
    Figure 7. Activating the Health Monitor

On activation, the Health Monitor will generate a number of new folders in the 'System Health Monitor' folder as well as underneath each Component object (i.e. local Core, Connector, Relay)

The I/O Model and the Health Monitor Properties after first activation
Figure 8. The I/O Model and the Health Monitor properties after first activation

The folders created under the Parent folder (under the Core on the same level as the health monitor and then subsequently under other components) are named according to function, for example "Health Calculation", "MongoDB Monitoring" "Performance Counter". Under each folder can be a subfolder system but most will ultimately contain Generic Items that either perform calculations (executing Lua scripts) or are assigned to performance counters (in the case of the "Performance Counter" folder).

The "Performance Counter" folder under the Core has a subfolder structure with a separate folder for each component. The created Generic Items with performance counter assignment are for selected component performance counters so not all counters will be necessarily represented.

Also, in the KPI Model, underneath the object specified in the KPI Model Base Path property of the Health Monitor object, a structure is created, representing the system’s performance counters.

The KPI Model after first activation of the Health Monitor
Figure 9. The KPI Model after first activation of the Health Monitor

In the Server Model, underneath the KPI Server Profile, a number of Dashboard and Widget objects are created.

The Server Model after first activation of the Health Monitor
Figure 10. The Server Model after first activation of the Health Monitor

Automatic Monitoring of new objects

When new objects of a type which can be monitored by the Health Monitor are added to the I/O Model, the infrastructure which is necessary for the Health Monitor is generated automatically.
In this example a new Connector called 'Remote Connector 2' will be added to the system.

The base case looks like this:

The three relevant models before a new service is installed
Figure 11. The three relevant models before a new service is installed

In the following screenshot, 'Remote Connector 2' has been added to the I/O Model. It’s in red state since the corresponding service has not been installed yet. After a brief moment, the Health Monitor infrastructure objects for 'Remote Connector 2' are created automatically in the I/O Model, the Server Model, and the KPI Model.

When a new Object is added to the I/O Model
Figure 12. When a new Object is added to the I/O Model, the Health Monitor infrastructure is automatically generated

As soon as connection to the corresponding Connector service is established, the Connector object and the related objects of the Health Monitor infrastructure go into green state.

Service object and Health Monitor infrastructure objects go into green state when a connection to the service is established
Figure 13. Service object and Health Monitor infrastructure objects go into green state when a connection to the service is established