WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

The System Healthcheck is a framework for monitoring various aspects of a NetKernel system to pro-actively look for problem situations and then provide notification.

Notification

The System Healthcheck supports notification to the Management Console and into the System Healthcheck tool itself.

In addition you can configure the invocation of a webhook to publish the health status in realtime to a remote aggregating service.

Configure Webhook

The configuration can be found on the healthcheck settings page found by clicking the "settings" button on the main health check page.

The webhook is configured by the following values:

  • URL - the http: or https: URL of the webhook. Leave blank for no webhook nofication.
  • Tolerant - if checked then connections to the webhook are accepted even if the webhook has self-signed or expired certificate.
  • Format - the format of the message body sent to the webhook can be either XML or JSON.
  • Frequency - the frequency of checking system health and invoking webhook.
  • Heartbeat - if checked the webhook is invoked even when the system health has not changed. This allows for a heartbeat function - so that if the webhook stops receiving messages it knows there has been problem.

The schema of the XML message is as follows:

<healthcheck>
  <instanceId>My NetKernel Instance</instanceId>
  <timestamp>1476279123760</timestamp>
  <status>warning</status>
  <checks>
    <check>
      <name>Enterprise Licence Validity</name>
      <status>healthy</status>
      <message />
    </check>
    <check>
      <name>Logged Errors and Warnings</name>
      <status>warning</status>
      <message>Last WARNING logged 9s ago</message>
    </check>
    <check>
      <name>Space Integrity</name>
      <status>healthy</status>
      <message />
    </check>
    <check>
      <name>1060 Alerts</name>
      <status>healthy</status>
      <message>No recent alerts reported on 1060 Research news feed</message>
    </check>
  </checks>
</healthcheck>

The schema of the JSON message is as follows:

{
    "instanceId": "My NetKernel Instance",
    "timestamp": "1476279123760",
    "status": "warning",
    "check": [
        {
            "name": "Enterprise Licence Validity",
            "status": "healthy",
            "message": " "
        },
        {
            "name": "Logged Errors and Warnings",
            "status": "warning",
            "message": "Last WARNING logged 9s ago"
        },
        {
            "name": "Space Integrity",
            "status": "healthy",
            "message": " "
        },
        {
            "name": "1060 Alerts",
            "status": "healthy",
            "message": "No recent alerts reported on 1060 Research news feed"
        }
    ]
}

The status field may have one of the following values:

  • error
  • warning
  • information
  • healthy

Remote Monitoring

A remote monitor service may poll the healthcheck status of a given NetKernel instance with this service interface...

/tools/ee/healthcheck/monitor

Built in Healthchecks

The following healthchecks are built in:

  • Log - warnings and/or errors reported in system log
  • Space Integrity - errors reported in deployed modules and spaces
  • 1060 Alerts - advisories and warnings issued by 1060
  • Commercial License Validity - advance warning of expiration of licenses
  • Software Updates - updates to installed modules are available to be installed

Pluggable Architecture

A number of standard heathchecks are shipped with NetKernel Enterprise Edition. Addition custom health checks can be added based on your own requirements or for specific deployed functionality.