Monitoring
The OTH Software Stack does not by default provide a monitoring solution other than a very basic services health-endpoints checks, described below.
Warning
It is highly recommended to setup monitoring and alerting, to be able to respond to system incidents and failures in a timely manner.
It is recommended to do performance and capacity monitoring, to ensure enough resources are allocated to the platform at any given time.
Service health-endpoints
Each service can be polled for its health status by sending a GET request to the external FQDN of the OTH Platform on port 443 with the URI described in the table below. E.g. send a curl request in the form :
curl -v https://mytelehealth-solution.com/<URI>
Expected output is a 2xx or 3xx HTTP status code with the body being a JSON formatted output describing the “environment” and “version” of the service. HTTP status codes 4xx, 5xx should be considered as service down or inaccessible. Consult the troubleshooting section of this guide for how to handle unexpected results.
Only endpoints for services deployed for any given solution, returns the “expected HTTP status code”.
| Service | URI | Expected HTTP status code |
|---|---|---|
| audit | /audit/health | 200 |
| calendar | /calendar/health | 200 |
| chat | /chat/health | 200 |
| client-citizen | /client-citizen/index.html | 200 |
| clinician | /clinician/health | 200 |
| client-clinician | /client-clinician/index.html | 200 |
| courses | /courses/health | 200 |
| developerportal | /api/docs | 200 |
| ecg | /ecg/health | 200 |
| guidance | /guidance/health | 200 |
| hl7 | /hl7/health | 200 |
| idp2 | /idp2/health | 200 |
| logging | /logging/health | 200 |
| measurements | /measurements/health | 200 |
| meetings | /meetings/health | 200 |
| notifications | /notifications/health | 200 |
| objectstorage | /object-storage/health | 200 |
| organizations | /organizations/health | 200 |
| qnrui | /qnr-ui/app.js | 200 |
| questionnaires | /questionnaires/health | 200 |
| results | /results/health | 200 |
| thresholds | /thresholds/health | 200 |
| uis | /uis/ | 200 |
All services should be deemed up or down solely on the HTTP status code. The JSON body returned for some of the service health endpoints are purely informational.
The following services do not return a JSON body with version info, when polling the service health endpoint:
client-citizen, client-clinician, developer-portal, qnrui, uis