¶ UI
HTML representation showing the states of all services
¶ API Routes
¶ Get all services
No authentication required
URL : /api/Services/
Method : GET
Auth required : No
¶ Success Response
Code : 200 OK
Content examples
// 20220530183405
// https://healthcheck-radix-2.calibrate.at/api/Services
{
"name": "radixAPI",
"currentState": {
"state": "online",
"lastChecked": "2022-05-30T16:33:15.878Z",
"stateSince": "2022-05-30T16:32:15.871Z",
"errorMessage": ""
},
"previousStates": null,
"services": [
{
"name": "radix-service-worker",
"version": "1.3.0",
"started": "2022-05-30T16:07:15.177Z",
"modules": [
],
"checks": [
{
"name": "checkDatabaseConnection",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.169Z",
"message": "Database is connected"
},
{
"name": "checkRedisConnection",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.169Z",
"message": "Redis Connected!"
},
{
"name": "checkTcpConnection",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.169Z",
"message": "Radix-Api TCP Server is up and running on radix-api:8887"
}
]
},
{
"name": "radix-api",
"version": "1.3.0",
"started": "2022-05-30T16:07:19.221Z",
"modules": [
{
"name": "jts",
"version": "2.0.0"
}
],
"checks": [
{
"name": "checkDatabaseConnection",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.230Z",
"message": "Database is connected"
},
{
"name": "checkRootDiscSpace",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.230Z",
"message": "overlay 457532960 48169724 386052116 12% /"
},
{
"name": "checkStorageDiscSpace",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.230Z",
"message": "/dev/md2 457532960 48169724 386052116 12% /root/data"
},
{
"name": "checkTcpConnection",
"status": "pass",
"checkedAt": "2022-05-30T16:33:15.230Z",
"message": "Radix-Service-Worker TCP Server is up and running on radix-service-worker:8877"
}
]
}
]
}
¶ Object model
name -> radixAPI - static value
¶ currentState
overall state of all service
state → online or error
lastChecked → timestamp - last check of all individual services
errorMessage → detailed information in case of "state" = "error"
¶ previousStates
collection of states at the time when the state property changed
¶ Service-Object
A service has the following properties:
- name → for now the service name in lowercase with no spaces
- version → Version of the service (not filled for all Services)
- started → time when the service was started (if time is available)
- modules → collection of Module-Objects
- checks → collection of Check-Objects
¶ Modul-Object
This object gives information about the installed version of certain moduls
- name
- version
¶ Check-Object
This object gives information about a check for a specific aspect of the overall service
- name → name of the check
- status → pass | fail
- message → detailed information