Edge Technologies, Inc. | Documentation | CheckHealth Server Status Monitoring

checkhealth Server Statuses

Used to check the system’s health. To do so, enter checkhealth in the URL: localhost:8080/checkhealth

The server status and status code will depend on the following cases:

If the server is available, licensed, not in maintenance mode, and successfully initialized, its status is “server initialized”;
In this case, the following JSON is returned:
```
{ "status": "server initialized", "statusCode": 200, "licensed": true, "clustered": false, "initialized": true }
```
If the server is in maintenance mode, its status is “server not available”;
In this case, the following JSON is returned:
```
{ "status": "server not available", "statusCode": 503, "licensed": true, "clustered": false, "initialized": true }
```
If the server is part of a cluster and is unavailable for any other reason, the server status is “cluster node not available”;
In this case, the following JSON is returned:
```
{ "status": "cluster node not available", "statusCode": 503, "licensed": true, "clustered": true, "initialized": true } 
```

JSON Response

As seen above, the following fields are returned in the response:

Field	Description
status	Server status Possible statuses: server initialized, server not available, cluster node not available;
statusCode	Status code Possible values: 200, 503;
licensed	Possible values: – true when the server is licensed for end-users; The server must be licensed in order to be available for end-users; – false when the server is not licensed for end-users;
clustered	Possible values: – true when the server is in a cluster; – false when the server is not in a cluster;
clusterAvailable	Returned only if clustered = true. clusterAvailable can be either true or false to specify whether the cluster is available. This must be true for end-users to be able to interact and perform many admin features like provisioning or editing content.
initialized	Specifies whether the server is fully initialized and can have the following values: – true when all the services are running and would be when admin calls are possible, whether or not the server is licensed or otherwise available for end-users; – false when the server is not fully initialized;

Customizing the CheckHealth Status JSP File

The system allows for customization of the checkhealth file when the steps above are not sufficient. The backing JSP file 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:

copy checkhealth.edgejsp from [INSTALL_HOME]/tomcat/webapps/ROOT/WEB-INF/jsp/checkhealth.edgejsp
to a custom location [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.