Oracle Cloud Infrastructure Documentation

Viewing Health Status and Health Check Configuration

On Compute Cloud@Customer, you can view the overall health of a load balancer (LB) and backend set of servers and the specific health checker configuration values set for the backend set.

Overall Health

  • Critical

  • Warning

  • Incomplete

  • Pending

  • OK

Health Checker Configuration Parameters

  • Protocol - HTTP or TCP

  • Port - The backend server port against which to run the health check

  • Interval In Milliseconds - Time between health checks

  • Timeout In Milliseconds - Maximum time to wait for the health check response

  • Number of Retries - The number of retries to attempt before a backend server is considered "unhealthy"

  • Status Code (HTTP only) - The code a healthy backend server should return

  • URL Path (HTTP only, Optional) - The path against which to run the health check

    1. In the Compute Cloud@Customer Console navigation menu, select Networking, then select Load Balancers.

    2. At the top of the page, select the compartment that contains the load balancer.

    3. Select the name of the LB for which you want to view health status and configuration.

      On the LB details page, the Overall Health of the LB is shown in the second column of the Load Balancer Information tab.

    4. On the LB details page, under Resources, select Backend Sets.

    5. Select the name of the backend set for which you want to view health status and configuration.

      On the backend set details page, the Overall Health of the servers in the backend set is shown in the first column of the Backend Set Information tab.

    6. On the backend set details page, select the Backend Set Configuration tab.

      All health check configuration parameters listed at the beginning of this section are shown in the Health Checker Configuration column.

    7. On the backend set details page, under Resources, select Backends.

      The overall health of each backend server is shown in the Overall Health column.

  • Use the oci lb backend-set-health get command and required parameters to view the parameters used by the backend set of an existing load balancer to check the health of the backend servers in the set.

    oci lb backend-set-health get --backend-set-name <backend-set-name-text> --load-balancer-id <load-balancer_OCID>

    Procedure

    1. Gather the information you need to run the command:

      • Compartment OCID: oci iam compartment list

      • LB OCID: oci lb load-balancer list

      • Backend set name: oci lb backend-set list

    2. List the health statuses for all load balancers in the specified compartment.

      $ oci lb load-balancer-health list --compartment-id compartment_OCID

    3. Show the health status for the specified load balancer.

      $ oci lb load-balancer-health get --load-balancer-id loadbalancer_OCID

    4. Show the health status for the specified backend set.

      $ oci lb backend-set-health get --load-balancer-id loadbalancer_OCID \
--backend-set-name backendset_name

    5. Show the health status of the specified backend server.

      $ oci lb backend-health get --load-balancer-id loadbalancer_OCID \
--backend-set-name backendset_name --backend-name backend_name

      The backend_name is the IP address and port of the backend server to retrieve the health status for, such as 10.0.0.3:8080.

    6. Show the health check policy information for the specified load balancer and backend set.

      $ oci lb health-checker get --load-balancer-id loadbalancer_OCID \
--backend-set-name backendset_name

      Health check configuration parameters listed at the beginning of this section are shown.

    For a complete list of CLI commands, flags, and options, see the Command Line Reference.

  • Use the GetBackendSetHealth operation to view the parameters used by the backend set of an existing load balancer to check the health of the backend servers in the set.

    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.