8 Copyright (C) The Arvados Authors. All rights reserved.
10 SPDX-License-Identifier: CC-BY-SA-3.0
13 Health check endpoints are found at @/_health/ping@ on many Arvados services. The purpose of the health check is to be a simple method of determining if a service can be contacted and if it believes it is functioning properly, suitable for integrating into operational alert systems.
15 Health check endpoints must be configured with a "management token":management-token.html .
17 This endpoint returns 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:
28 "error": "Inverted polarity of the warp core"
32 h2. Healthcheck aggregator
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@ .
36 The healthcheck aggregator uses the "NodeProfile" section of the cluster-wide configuration file. Here is an example.
40 # The cluster uuid prefix
43 # For each node, the profile name corresponds to a
44 # locally-resolvable hostname, and describes which Arvados
45 # services are available on that machine.