If you want to monitor the health status of yuuvis® RAD including visualizations and notifications, yuuvis® metrics-manager is your best choice. However, if you already have your own (company wide) monitoring system like Nagios or alike, then http API endpoints are probably more what you are looking for. This page describes in detail for each component of yuuvis® RAD which endpoints you can use and which information you get out of it.
...
The Service-Manager consists of individual microservices that each offer a health check API endpoint. This can be queried by calling http://<service-manager-ip>:<microservice-instance-port>/manage/health.
As an example the (first) index-service instance will listen on port 7291 and thus its health can be checked by calling http://127.0.0.1:7291/manage/health and will return one of the following answers:
- http response 200 with body: {"status": "UP"} → this means the service itself an all dependencies are available and running correctly.
- http response 200 with body: {"status": "DOWN"} → this means either the service itself and/or one / multiple dependencies are not available or not working correctly.
- connection refused → service is not available → this means the service is either not started / crashed or it is not working correctly.
Attention: The structure microservice behaves differently and even reports status "UP" when one or more of its dependencies is "DOWN". The depencies are listed in the body and show which one is "UP" or "DOWN".
An overview of all possible microservices including their ports or port-ranges can be found here: https://help.optimal-systems.com/yuuvisRAD/v70/admin/en/architecture/microservices/mic_ref_uebersicht-microservices.htm
The admin-service applications endpoint
Alternatively the admin-microservice offers an API endpoint that aggregates all states: http://<service-manager-ip>:7273/applications
If the admin-service itself is up and running correctly the call returns an http response of 200 and a body like below.
...
The health status of elasticsearch can be queried by calling this URL: http://<elasticsearch-ip>:9200/_cat/health
The endpoint requires authorization. If the connection is not refused (elaasticsearch is offline) and the authorization is correct, an http response of 200 and a body like below will be returned.
[
{
"epoch": "1611682123",
"timestamp": "17:28:43",
"cluster": "es-red",
"status": "green",
"node.total": "1",
"node.data": "1",
"shards": "11",
"pri": "11",
"relo": "0",
"init": "0",
"unassign": "0",
"pending_tasks": "0",
"max_task_wait_time": "-",
"active_shards_percent": "100.0%"
}
]
The values of "status" and "active_shards_percent" determine the health of elasticsearch.
...