15577: Edits based on feedback
[arvados.git] / doc / admin / health-checks.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: Health checks
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 Health check endpoints are found at @/_health/ping@ on many Arvados services.  The purpose of the health check is to offer a simple method of determining if a service can be reached and allow the service to self-report any problems, suitable for integrating into operational alert systems.
14
15 To access health check endpoints, services must be configured with a "management token":management-token.html .
16
17 Health check endpoints return a JSON object with the field @health@.  This has a value of either @OK@ or @ERROR@.  On error, it may also include a  field @error@ with additional information.  Examples:
18
19 <pre>
20 {
21   "health": "OK"
22 }
23 </pre>
24
25 <pre>
26 {
27   "health": "ERROR"
28   "error": "Inverted polarity in the warp core"
29 }
30 </pre>
31
32 h2. Healthcheck aggregator
33
34 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@ .
35
36 The healthcheck aggregator uses the @NodeProfile@ section of the cluster-wide @arvados.yml@ configuration file.  Here is an example.
37
38 <pre>
39 Cluster:
40   # The cluster uuid prefix
41   zzzzz:
42     ManagementToken: xyzzy
43     NodeProfile:
44       # For each node, the profile name corresponds to a
45       # locally-resolvable hostname, and describes which Arvados
46       # services are available on that machine.
47       api:
48         arvados-controller:
49           Listen: :8000
50         arvados-api-server:
51           Listen: :8001
52       manage:
53         arvados-node-manager:
54           Listen: :8002
55       workbench:
56         arvados-workbench:
57           Listen: :8003
58         arvados-ws:
59           Listen: :8004
60       keep:
61         keep-web:
62           Listen: :8005
63         keepproxy:
64           Listen: :8006
65         keep-balance:
66           Listen: :9005
67       keep0:
68         keepstore:
69           Listen: :25107
70       keep1:
71         keepstore:
72           Listen: :25107
73 </pre>