The plugin does not require any configuration at all and exposes an HTTP endpoint for querying the service status.
GET /config/server/healthcheck~status
)]}'
{
"ts": 139402910202,
"elapsed": 100,
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
"result": "passed"
},
"projectslist": {
"ts": 139402910202,
"elapsed": 100,
"result": "passed"
},
"auth": {
"ts": 139402910202,
"elapsed": 80,
"result": "passed"
}
}
The plugin allows to customize its behaviour through a specific healthcheck.config file in the $GERRIT_SITE/etc directory.
Each section of the form [healthcheck "<checkName>"] can tailor the behaviour of an individual <checkName>. The section [healthcheck] defines the global defaults valid for all checks.
The following check names are available:
reviewdb : check connectivity and ability to query ReviewDbjgit : check connectivity to the filesystem and ability to open a JGit ref and objectprojectslist : check the ability to list projects with their descriptionsThe follwing parameters are available:
healthcheck.<checkName>.timeout : Specific timeout (msec) for the healthcheck to complete. Zero means that there is no timeout.
Default: 500