X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c3b26754a231ec909506f2ff28af1af9f2e27f2b..48afa5ce8f43ba08e52a31e1ddfc8f93a3cdcf78:/doc/admin/health-checks.html.textile.liquid diff --git a/doc/admin/health-checks.html.textile.liquid b/doc/admin/health-checks.html.textile.liquid index eb71fda5e6..fa273cd204 100644 --- a/doc/admin/health-checks.html.textile.liquid +++ b/doc/admin/health-checks.html.textile.liquid @@ -29,45 +29,43 @@ Health check endpoints return a JSON object with the field @health@. This has a } -h2. Healthcheck aggregator +h2. Health check aggregator The service @arvados-health@ performs health checks on all configured services and returns a single value of @OK@ or @ERROR@ for the entire cluster. It exposes the endpoint @/_health/all@ . -The healthcheck aggregator uses the @NodeProfile@ section of the cluster-wide @arvados.yml@ configuration file. Here is an example. +The healthcheck aggregator uses the @Services@ section of the cluster-wide @config.yml@ configuration file. -
-Cluster: - # The cluster uuid prefix - zzzzz: - ManagementToken: xyzzy - NodeProfile: - # For each node, the profile name corresponds to a - # locally-resolvable hostname, and describes which Arvados - # services are available on that machine. - api: - arvados-controller: - Listen: :8000 - arvados-api-server: - Listen: :8001 - manage: - arvados-node-manager: - Listen: :8002 - workbench: - arvados-workbench: - Listen: :8003 - arvados-ws: - Listen: :8004 - keep: - keep-web: - Listen: :8005 - keepproxy: - Listen: :8006 - keep-balance: - Listen: :9005 - keep0: - keepstore: - Listen: :25107 - keep1: - keepstore: - Listen: :25107 -+h2. Health check command + +The @arvados-server check@ command is another way to perform the same health checks as the health check aggregator service. It does not depend on the aggregator service. + +If all checks pass, it writes @health check OK@ to stderr (unless the @-quiet@ flag is used) and exits 0. Otherwise, it writes error messages to stderr and exits with error status. + +@arvados-server check -yaml@ outputs a YAML document on stdout with additional details about each service endpoint that was checked. + +{% codeblock as yaml %} +Checks: + "arvados-api-server+http://localhost:8004/_health/ping": + ClockTime: "2022-11-16T16:08:57Z" + ConfigSourceSHA256: e2c086ae3dd290cf029cb3fe79146529622279b6280cf6cd17dc8d8c30daa57f + ConfigSourceTimestamp: "2022-11-07T18:08:24.539545Z" + HTTPStatusCode: 200 + Health: OK + Response: + health: OK + ResponseTime: 0.017159 + Server: nginx/1.14.0 + Phusion Passenger(R) 6.0.15 + Version: 2.5.0~dev20221116141533 + "arvados-controller+http://localhost:8003/_health/ping": + ClockTime: "2022-11-16T16:08:57Z" + ConfigSourceSHA256: e2c086ae3dd290cf029cb3fe79146529622279b6280cf6cd17dc8d8c30daa57f + ConfigSourceTimestamp: "2022-11-07T18:08:24.539545Z" + HTTPStatusCode: 200 + Health: OK + Response: + health: OK + ResponseTime: 0.004748 + Server: "" + Version: 2.5.0~dev20221116141533 (go1.18.8) +# ... +{% endcodeblock %}