You can run a health check utility on a Rules Service by browsing
host:port/healthcheckFor example:
http://localhost:7782/healthcheckwhere port is the Windows Service port number of the Rules Service you want to check.
You can also run a health check on a USoft Service Framework server.
Visiting the /healthcheck endpoint returns code 200 (OK) if everything is OK, and code 503 (Service unavailable) otherwise.
This API returns a JSON object with the following properties.
| Property | Description | Type |
|---|---|---|
| timestamp | The current date and time in format: | Date value in format: YYYY-MM-DD HH:MM:SS.sss |
| healthy | An indication of whether the Rules Service runs successfully or not | Boolean |
| application | Name of the USoft application as known in Authorizer | String |
| message | Explanation of problem | String |
The application property is only displayed if the application is found running in the Rules Service.
The message property can show these messages:
| Message | Explanation |
|---|---|
| Application could not be found | The application could not be found running in any Rules Engine. |
| Authorizer could not be found | The Rules Service is running but cannot connect to USoft Authorizer. |
| Database unreachable | The application cannot connect to the database. |
| Engine could not be found | The Rules Service could not access any Rules Engine. |
| TBD | (Error generated by the engine itself) |
| Unable to read the configuration | The Rules Service was not successfully or fully configurated. This occurs when you do not pursue ure.config wizard until the last wizard step (Finish) included. |
Examples
{
"timestamp" : "2022-08-19 16:00:39.228",
"healthy" : false,
"message" : "Unable to read the configuration"
}{
"timestamp" : "2022-08-19 16:04:39.969",
"healthy" : true,
"application" : "TRAVEL"
}
Sign up for the USoft Community