JSON Health Check API
IDOL Site Admin includes a JSON health check test, which you can use in conjunction with external monitoring systems such as Nagios to check the status of the IDOL Site Admin back-end components. Authentication is not required to use this feature.
To run a health check
- In your Web browser, go to
http://host:port/api/external/health/healthCheck.json
, wherehost
andport
are the host name or IP address and port details of your IDOL Site Admin installation. -
The output indicates the health of each component in the form of
componentName
andstate
pairs, and also shows the number of warnings or errors. For example:{"componentHealth":[{"componentName":"DOC.TRACKING","state":"DISABLED"},{"componentName":"COMMUNITY","state":"UP"},{"componentName":"POSTGRES","state":"UP"},{"componentName":"COORDINATOR","state":"UP"}],"numWarnings":0,"numErrors":0}