Oracle Cloud Infrastructure Documentation

Configuring the Health Check

Set up the health check policy for a network load balancer backend set using the OCI Console.

  1. Open the navigation menu, click Networking, and then click Load balancers. Click Network load balancer. The Network load balancers page appears.
  2. Select the Compartment from the list. All network load balancers in that compartment are listed in tabular form.
  3. Select a State from the list to limit the network load balancers displayed to that state.
  4. Select the network load balancer containing the backend set whose health check you want to configure. The network load balancer's Details page appears.
  5. Click Backend sets under Resources. The Backend sets list appears. All backend sets are listed in tabular form.
  6. Click the backend set whose health checking you want to configure. The backend set's Details page appears.
  7. Click Update health check. The Health check section appears.
  8. Specify the test parameters to confirm the health of backend servers. All parameters are required when updating an existing health check policy.

    • Protocol: Specify the protocol to use, either HTTP or TCP.

      Note

      Configure your health check protocol to match your application or service.

    • Port: Specify the backend server port against which to run the health check.

      Note

      You can enter the value '0' to have the health check use the backend server's traffic port.

    • URL path (URI): (HTTP only) Specify a URL endpoint against which to run the health check.

      For example: 

      /health

      (This value is a commonly used path for a health check application).

    • Interval in MS: Specify how often to run the health check, in milliseconds. Default is 10000 (10 seconds).

    • Timeout in MS: 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).

      Note

      Enter a timeout value that's smaller than the interval value to ensure the health check works correctly.

    • Number of retries: Specify the number of retries to try before a backend server is considered "unhealthy." This number also applies when recovering a server to the "healthy" state. The 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 ".*".

      Note

      Health checks require all fields to match. The status code and response body both must match, as specified.

  9. Click Save.