| commit | a59f9577157613e50323fcfd2534045144782f99 | [log] [tgz] |
|---|---|---|
| author | Antonio Barone <syntonyze@gmail.com> | Mon Jan 21 14:28:18 2019 +0000 |
| committer | Antonio Barone <syntonyze@gmail.com> | Tue Jan 22 16:14:51 2019 +0000 |
| tree | d8cfd3ddcb9438669f0f8578f0378cd6dda251aa | |
| parent | 04e9e012731d6367e816e22faf9b6878d627671d [diff] |
Send metrics when running healthcheck Upon running healthcheck, healthcheck components metrics are propagated. Failure count: * plugins_healthcheck_jgit_failure_total * plugins_healthcheck_reviewdb_failure_total * plugins_healthcheck_projectslist_failure_total Latency (Timer): the elapsed time for executing that specific healthcheck * plugins_healthcheck_jgit_latency * plugins_healthcheck_projectslist_latency * plugins_healthcheck_reviewdb_latency Feature: Issue 10321 Change-Id: I1b393258dc823b19b74106fa7fce377d5c8bba92
Allow having a single entry point to check the availability of the services that Gerrit exposes.
Clone or link this plugin to the plugins directory of Gerrit‘s source tree, and then run bazel build on the plugin’s directory.
Example:
git clone --recursive https://gerrit.googlesource.com/gerrit git clone https://gerrit.googlesource.com/plugins/healthcheck pushd gerrit/plugins && ln -s ../../healthcheck . && popd cd gerrit && bazel build plugins/healthcheck
The output plugin jar is created in:
bazel-genfiles/plugins/healthcheck/healthcheck.jar
Copy the healthcheck.jar into the Gerrit's /plugins directory and wait for the plugin to be automatically loaded.
The healthcheck plugin exposes a single endpoint under its root URL and provides a JSON output of the Gerrit health status.
The HTTP status code returned indicates whether Gerrit is healthy (HTTP status 200) or has some issues (HTTP status 500).
The HTTP response payload is a JSON output that contains the details of the checks performed.
Each check returns a JSON payload with the following information:
ts: epoch timestamp in millis of the individual check
elapsed: elapsed time in millis to complete the check
result: result of the health check
Example of a healthy Gerrit response:
GET /config/server/healthcheck~status
200 OK
Content-Type: application/json
{
"ts": 139402910202,
"elapsed": 100,
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
"result": "passed"
},
"projectslist": {
"ts": 139402910202,
"elapsed": 100,
"result": "passed"
},
"jgit": {
"ts": 139402910202,
"elapsed": 80,
"result": "passed"
}
}
Example of a Gerrit instance with the projects list timing out:
GET /config/server/healthcheck~status
500 ERROR
Content-Type: application/json
{
"ts": 139402910202,
"elapsed": 100,
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
"result": "passed"
},
"projectslist": {
"ts": 139402910202,
"elapsed": 100,
"result": "timeout"
},
"jgit": {
"ts": 139402910202,
"elapsed": 80,
"result": "passed"
}
}
As for all other endpoints in Gerrit, some metrics are automatically emitted when the /config/server/healthcheck~status endpoint is hit (thanks to the Dropwizard library).
Some additional metrics are also produced to give extra insights on their result about results and latency of healthcheck sub component, such as jgit, reviewdb, etc.
More information can be found in the config.md file.