Skip to main content

Health Check

Health Check

Easy RPA comes with pre-installed Health Check that exposes two interfaces:

  • Rest API
  • Web UI

Rest API

Using Rest API is as simple as issuing HTTP GET request against address http://<Control Server Host>:8447/actuator/health. In response following simple JSON structure will be returned:

Easy RPA Health Check Result JSON
{
	"status": "DOWN",
	"components": {
		"ActiveMQ": {
			"status": "UP"
		},
		"ControlServer": {
			"status": "UP"
		},
		"ControlServerUI": {
			"status": "UP"
		},
		"Elasticsearch": {
			"status": "UP"
		},
		"Grafana": {
			"status": "UP"
		},
		"HelpCenter": {
			"status": "UP"
		},
		"Kibana": {
			"status": "UP"
		},
		"Minio": {
			"status": "DOWN",
			"details": {
				"error": "Error: 1 expectation failed. Expected status code <200> but was <401>."
			}
		},
		"Nexus": {
			"status": "DOWN",
			"details": {
				"error": "Error: Connection refused: connect"
			}
		},
		"OAuthServer": {
			"status": "UP"
		},
		"Telegraf": {
			"status": "UP"
		},
		"Vault": {
			"status": "UP"
		},
		"db": {
			"status": "UP",
			"details": {
				"database": "PostgreSQL",
				"validationQuery": "isValid()"
			}
		},
		"influxDb": {
			"status": "UP",
			"details": {
				"version": "2.1.1"
			}
		},
		"mongo": {
			"status": "UP",
			"details": {
				"version": "4.2.7"
			}
		}
	}
}


If needed, only specific component status can be requested  - for that add component name to the address URL like in the following example http://<Control Server Host>:8447/actuator/health/influxDb

Specific component status JSON
{
	"status": "UP",
	"details": {
		"version": "2.1.1"
	}
}

Web UI

User-friendly HTML version of the Health Check is available at the address http://<Control Server Host>:8447/. In the returned table unhealthy components can be easily spotted by orange label with the DOWN text.

Additionally Unhealthy button (next to All button) if pressed will leave only unhealthy components in the list.

Details column can provide some extra info for the problem or component state.