github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #689 from ryanbreen/health

Browse Source 
Website: cleanup for docs/agent/http/health.
pull/675/merge
Armon Dadgar 10 years ago
parent f3169c7fa4 03fad82b09
commit 79d28b9baf
1 changed files with 32 additions and 38 deletions
Show Stats Download Patch File Download Diff File

70
website/source/docs/agent/http/health.html.markdown
Unescape View File

@ -3,15 +3,15 @@ layout: "docs"
page_title: "Health Checks (HTTP)" page_title: "Health Checks (HTTP)"
sidebar_current: "docs-agent-http-health" sidebar_current: "docs-agent-http-health"
description: > description: >
The Health used to query health related information. The Health endpoints are used to query health-related information.
--- ---
# Health HTTP Endpoint # Health HTTP Endpoint
The Health used to query health related information. It is provided separately The Health endpoints are used to query health-related information. They are provided separately
from the Catalog, since users may prefer to not use the health checking mechanisms from the Catalog since users may prefer not to use the optional health checking mechanisms.
as they are totally optional. Additionally, some of the query results from the Additionally, some of the query results from the Health endpoints are filtered while the Catalog
Health system are filtered, while the Catalog endpoints provide the raw entries. endpoints provide the raw entries.
The following endpoints are supported: The following endpoints are supported:
@ -20,14 +20,13 @@ The following endpoints are supported:
* [`/v1/health/service/<service>`](#health_service): Returns the nodes and health info of a service * [`/v1/health/service/<service>`](#health_service): Returns the nodes and health info of a service
* [`/v1/health/state/<state>`](#health_state): Returns the checks in a given state * [`/v1/health/state/<state>`](#health_state): Returns the checks in a given state
All of the health endpoints supports blocking queries and all consistency modes. All of the health endpoints support blocking queries and all consistency modes.
### <a name="health_node"></a> /v1/health/node/\<node\> ### <a name="health_node"></a> /v1/health/node/\<node\>
This endpoint is hit with a GET and returns the node specific checks known. This endpoint is hit with a GET and returns the checks specific to the node
By default the datacenter of the agent is queried, provided on the path. By default, the datacenter of the agent is queried;
however the dc can be provided using the "?dc=" query parameter. however, the dc can be provided using the "?dc=" query parameter.
The node being queried must be provided after the slash.
It returns a JSON body like this: It returns a JSON body like this:
@ -56,22 +55,20 @@ It returns a JSON body like this:
] ]
``` ```
In this case, we can see there is a system level check (no associated In this case, we can see there is a system level check (that is, a check with
`ServiceID`, as well as a service check for Redis). The "serfHealth" check no associated `ServiceID`) as well as a service check for Redis. The "serfHealth" check
is special, in that all nodes automatically have this check. When a node is special in that it is automatically present on every node. When a node
joins the Consul cluster, it is part of a distributed failure detection joins the Consul cluster, it is part of a distributed failure detection
provided by Serf. If a node fails, it is detected and the status is automatically provided by Serf. If a node fails, it is detected and the status is automatically
changed to "critical". changed to `critical`.
This endpoint supports blocking queries and all consistency modes. This endpoint supports blocking queries and all consistency modes.
### <a name="health_checks"></a> /v1/health/checks/\<service\> ### <a name="health_checks"></a> /v1/health/checks/\<service\>
This endpoint is hit with a GET and returns the checks associated with This endpoint is hit with a GET and returns the checks associated with
a service in a given datacenter. the service provided on the path. By default, the datacenter of the agent is queried;
By default the datacenter of the agent is queried, however, the dc can be provided using the "?dc=" query parameter.
however the dc can be provided using the "?dc=" query parameter.
The service being queried must be provided after the slash.
It returns a JSON body like this: It returns a JSON body like this:
@ -94,25 +91,23 @@ This endpoint supports blocking queries and all consistency modes.
### <a name="health_service"></a> /v1/health/service/\<service\> ### <a name="health_service"></a> /v1/health/service/\<service\>
This endpoint is hit with a GET and returns the service nodes providing This endpoint is hit with a GET and returns the nodes providing
a given service in a given datacenter. the service indicated on the path. By default, the datacenter of the agent is queried;
By default the datacenter of the agent is queried, however, the dc can be provided using the "?dc=" query parameter.
however the dc can be provided using the "?dc=" query parameter.
The service being queried must be provided after the slash. By default By default, all nodes matching the service are returned. The list can be filtered
all nodes in that service are returned. However, the list can be filtered
by tag using the "?tag=" query parameter. by tag using the "?tag=" query parameter.
This is very similar to the /v1/catalog/service endpoint however, this Providing the "?passing" query parameter, added in Consul 0.2, will filter results
endpoint automatically returns the status of the associated health check, to only nodes with all checks in the `passing` state. This can be used to avoid extra filtering
as well as any system level health checks. This allows a client to avoid logic on the client side.
sending traffic to nodes failing health tests, or who are reporting warnings.
Providing the "?passing" query parameter will filter results to only nodes This endpoint is very similar to the /v1/catalog/service endpoint; however, this
with all checks in the passing state. This can be used to avoid some filtering endpoint automatically returns the status of the associated health check
logic on the client side. (Added in Consul 0.2) as well as any system level health checks. This allows a client to avoid
sending traffic to nodes that are failing health tests or reporting warnings.
Users can also built in support for dynamic load balancing and other features Users can also build in support for dynamic load balancing and other features
by incorporating the use of health checks. by incorporating the use of health checks.
It returns a JSON body like this: It returns a JSON body like this:
@ -160,13 +155,12 @@ This endpoint supports blocking queries and all consistency modes.
### <a name="health_state"></a> /v1/health/state/\<state\> ### <a name="health_state"></a> /v1/health/state/\<state\>
This endpoint is hit with a GET and returns the checks in a specific This endpoint is hit with a GET and returns the checks in the
state for a given datacenter. By default the datacenter of the agent is queried, state provided on the path. By default, the datacenter of the agent is queried;
however the dc can be provided using the "?dc=" query parameter. however, the dc can be provided using the "?dc=" query parameter.
The state being queried must be provided after the slash. The supported states The supported states are `any`, `unknown`, `passing`, `warning`, or `critical`.
are "any", "unknown", "passing", "warning", or "critical". The "any" state is The `any` state is a wildcard that can be used to return all checks.
a wildcard that can be used to return all the checks.
It returns a JSON body like this: It returns a JSON body like this:

Write Preview
Loading…
Cancel
Save