Health Check

Fudo Enterprise regularly checks its “health” status. There are multiple tests that check the status of both hardware and software components. These tests are called “health checks”.


The results of the health checks can be accessed by an administrator in two ways:

  1. Using SNMP, which provides all health check results.

  2. Using the API health check endpoint, which provides a summary of all health checks.


API Health Check

The API Health Check option is available under the Maintenance and Supervision section of the Settings > System tab, in the General subtab.

../../_images/5-6-system-health-check.png

Enabling this option activates an API endpoint that provides quick information about Fudo Enterprise’s health status. This endpoint can be used by external systems to periodically monitor the state of Fudo Enterprise.


The information is returned as a JSON object:

{
   "status": "${value}"
}

The ${value} may be set to:

  • ok: if Fudo Enterprise works properly

  • error: if Fudo Enterprise doesn’t work properly and some of it functions may not be available.

Note

The health check status is designed to be simple and easy to interpret, therefore it doesn’t contain detailed information about the problems that caused the error status. The detailed information about health check results can be obtained using SNMP.

Once the health check option is enabled, the following endpoint will be exposed at the URL path:

/api/v2/healthcheck

Warning

The API endpoint is accessible without authentication. It means that anyone having TCP access to Fudo Enterprise will be able to get information about its health status.