This topic describes how to modify health check policies for a backend set.
To use Oracle Cloud Infrastructure, you must be given the required type of access in a policy written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment you should work in.
For administrators: For a typical policy that gives access to load balancers and their components, see Let network admins manage load balancers.
Also, be aware that a policy statement with
inspect load-balancers gives the specified group the ability to see all information about the load balancers. For more information, see Details for Load Balancing.
A health check is a test to confirm the availability of backend servers. A health check can be a request or a connection attempt. Based on a time interval you specify, the load balancer applies the health check policy to continuously monitor backend servers. If a server fails the health check, the load balancer takes the server temporarily out of rotation. If the server subsequently passes the health check, the load balancer returns it to the rotation.
You configure your health check policy when you create a backend set. You can configure TCP-level or HTTP-level health checks for your backend servers.
- TCP-level health checks attempt to make a TCP connection with the backend servers and validate the response based on the connection status.
- HTTP-level health checks send requests to the backend servers at a specific URI and validate the response based on the status code or entity data (body) returned.
The service provides application-specific health check capabilities to help you increase availability and reduce your application maintenance window.
Configure your health check protocol to match your application or service.
If you run an HTTP service, be sure to configure an HTTP-level health check. If you run a TCP-level health check against an HTTP service, you might not get an accurate response. The TCP handshake can succeed and indicate that the service is up even when the HTTP service is incorrectly configured or having other issues. Although the health check appears good, customers might experience transaction failures. For example:
- The backend HTTP service has issues and returns 5XX messages. An HTTP health check catches the message and marks the service as down. In this case, a TCP health check handshake succeeds and marks the service as healthy, even though the HTTP service is not usable.
- The backend HTTP service responds with 4XX messages because of authorization issues or no configured content. A TCP health check does not catch these errors.
The Load Balancing service provides health status indicators that use your health check policies to report on the general health of your load balancers and their components. You can see health status indicators on the Console List and Details pages for load balancers, backend sets, and backend servers. You also can use the Load Balancing API to retrieve this information.
Health status indicators have four levels. The following table provides the general meaning of each level:
No attention required.
The resource is functioning as expected.
Some reporting entities require attention.
The resource is not functioning at peak efficiency or the resource is incomplete and requires further work.
Some or all reporting entities require immediate attention.
The resource is not functioning or unexpected failure is imminent.
Health status cannot be determined.
The resource is not responding or is in transition and might resolve to another status over time.
The precise meaning of each level differs among the following components:
At the highest level, load balancer health reflects the health of its components. The health status indicators provide information you might need to drill down and investigate an existing issue. Some common issues that the health status indicators can help you detect and correct include:
A health check is misconfigured.
In this case, all the backend servers for one or more of the affected listeners report as unhealthy. If your investigation finds that the backend servers do not have problems, then a backend set probably includes a misconfigured health check.
A listener is misconfigured.
All the backend server health status indicators report OK, but the load balancer does not pass traffic on a listener.
The listener might be configured to:
- Listen on the wrong port.
- Use the wrong protocol.
- Use the wrong policy.
If your investigation shows that the listener is not at fault, check the security list configuration.
A security rule is misconfigured.
Health status indicators help you diagnose two cases of misconfigured security rules:
- All entity health status indicators report OK, but traffic does not flow (as with misconfigured listeners). If the listener is not at fault, check the security rule configuration.
All entity health statuses report as unhealthy. You have checked your health check configuration and your services run properly on your backend servers.
In this case, your security rules might not include the IP range for the source of the health check requests. You can find the health check source IP on the Details page for each backend server. You can also use the API to find the IP in the
sourceIpAddressfield of the HealthCheckResult object.Note
The source IP for health check requests comes from a Compute instance managed by the Load Balancing service.
One or more of the backend servers reports as unhealthy.
A backend server might be unhealthy or the health check might be misconfigured. To see the corresponding error code, check the status field on the backend server's Details page. You can also use the API to find the error code in the
healthCheckStatus field of the HealthCheckResult object.
Other cases in which health status might prove helpful include:
Health Status Limitations
Health status is updated every three minutes. No finer granularity is available.
Health status does not provide historical health data.
Editing Health Check Policies
You create your health check tests when you create a backend set.
- Open the navigation menu. Under the Core Infrastructure group, go to Networking and click Load Balancers.
- Click the name of the Compartment that contains the load balancer you want to modify, and then click the load balancer's name.
- In the Resources menu, click Backend Sets, and then click the name of the backend set you want to modify.
- Click Update Health Check.
In the Health Check section, specify the test parameters to confirm the health of backend servers.
All parameters are required when updating an existing health check policy.
Protocol: Required. Specify the protocol to use, either HTTP or TCP.
Configure your health check protocol to match your application or service.
Port: Required. Specify the backend server port against which to run the health check.
You can enter the value '0' to have the health check use the backend server's traffic port.
- URL Path (URI): (HTTP only) Required. Specify a URL endpoint against which to run the health check.
- Interval in ms: Required. Specify how frequently to run the health check, in milliseconds. Default is 10000 (10 seconds).
Timeout in ms: Required. Specify the maximum time in milliseconds to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Default is 3000 (3 seconds).
Enter a timeout value that is smaller than the interval value to ensure the health check works correctly.
Number of retries: Required. Specify the number of retries to attempt before a backend server is considered "unhealthy." This number also applies when recovering a server to the "healthy" state. Default is 3.
- Status Code: (HTTP only) Required. Specify the status code a healthy backend server must return.
Response Body Regex: (HTTP only) Optional. Provide a regular expression for parsing the response body from the backend server. The system treats a blank entry here as the value ".*".
Health checks require all fields to match. Your status code and response body both must match, as specified.
- Click Save.
Using the API
For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.
Use this API operation to edit a backend set's health check policy:
Use these API operations to retrieve health status information: