The system health may be monitored by load balancers to help ensure the quality of service. The http://localhost:8080/checkhealth is the endpoint that a load balancer should be configured to test. By default it will return either of the following status codes and JSON responses:
"status": "server initialized",
"status": "server not available",
Status code will only be 200 if the server is licensed, the cluster is available if clustered, and the instance is fully initialized.
The system allows for customization of the /checkhealth file when the steps above are not sufficient. In this step, the backing JSP used by the CheckHealth Controller will be modified to enrich the status validation.
The default checkhealth file ([INSTALL_HOME]/tomcat/webapps/ROOT/WEB-INF/jsp/checkhealth.edgejsp) is used as a reference when creating custom check health logic, but it should not be modified directly. Instead, make a copy in [INSTALL_HOME]/jsp/checkhealth.edgejsp and modify that file. Any changes made directly in /WEB-INF/jsp/ will be lost on server restart and/or re-initialization.