Documentation: Add info about querychanges
Followup to I3625b6ad54bb9605c9ddb497923da9f161bbffa5
Also, remove trailing whitespace.
Change-Id: I6adf82dbc74b5ea471a67b23e1e8f6c816014c9f
Signed-off-by: Tyler Cipriani <tcipriani@wikimedia.org>
diff --git a/README.md b/README.md
index fe38bc8..f5af98a 100644
--- a/README.md
+++ b/README.md
@@ -37,16 +37,17 @@
- ts: epoch timestamp in millis of the test
- elapsed: elapsed time in millis to perform the check
+- querychanges: check that Gerrit can query changes
- reviewdb: check that Gerrit can connect and query ReviewDb
- projectslist: check that Gerrit can list projects
-- jgit: check that Gerrit can access repositories
+- jgit: check that Gerrit can access repositories
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
-
+
- passed: the check passed successfully
- failed: the check failed with an error
- timeout: the check took too long and timed out
@@ -59,9 +60,15 @@
200 OK
Content-Type: application/json
+)]}'
{
"ts": 139402910202,
"elapsed": 100,
+ "querychanges": {
+ "ts": 139402910202,
+ "elapsed": 20,
+ "result": "passed"
+ },
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
@@ -88,9 +95,15 @@
500 ERROR
Content-Type: application/json
+)]}'
{
"ts": 139402910202,
"elapsed": 100,
+ "querychanges": {
+ "ts": 139402910202,
+ "elapsed": 20,
+ "result": "passed"
+ },
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
@@ -117,4 +130,4 @@
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](resources/Documentation/config.md) file.
\ No newline at end of file
+More information can be found in the [config.md](resources/Documentation/config.md) file.
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index 74ad62c..5f448a1 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -14,6 +14,11 @@
{
"ts": 139402910202,
"elapsed": 100,
+ "querychanges": {
+ "ts": 139402910202,
+ "elapsed": 20,
+ "result": "passed"
+ },
"reviewdb": {
"ts": 139402910202,
"elapsed": 50,
@@ -44,6 +49,7 @@
The following check names are available:
+- `querychanges`: check the ability to query changes
- `reviewdb` : check connectivity and ability to query ReviewDb
- `jgit` : check connectivity to the filesystem and ability to open a JGit ref and object
- `projectslist` : check the ability to list projects with their descriptions
@@ -63,4 +69,4 @@
- `healthcheck.<checkName>.limit` : Maximum number of elements to retrieve from
the the check results.
- Default: 10
\ No newline at end of file
+ Default: 10
