Managing Health Checks

The Health Checks service allows you to monitor the health of IP addresses and hostnames, as measured from geographic vantage points of your choosing, using HTTP and ping probes. After configuring a health check, you can view the monitor's results. The results include the location from which the host was monitored, the availability of the endpoint, and the date and time the test was performed.

Using the Console

To add a health check
Important

If you have selected the HTTPS protocol for this monitor and have entered an IP address as a Target to be monitored, you must specify a Host header with the domain name associated with the TLS certificate for that target. If you do not add the Host header, the TLS connection phase will not complete successfully and the target endpoint will be declared unavailable. Note that this Host header is only required with IP address targets and HTTPS monitors.

  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Click Create Health Check.
  3. In the Create Health Check dialog box, enter the following:

    • Health Check Name: The name used for the health check. Avoid entering confidential information.
    • Compartment: Select the compartment the health check runs in.
    • Target(s): The IP address or fully qualified domain name (FQDN) of the host being monitored. Additional targets can be added.
    • Vantage Points: Select the location from which the health of the target is monitored. No more than ten vantage points can be added.
    • Request Type: Select the type of request sent to monitor the target.
      • HTTP - Enter the following:
        • Protocol: The network protocol used to interact with your endpoint, such as HTTP protocol, which initializes an HTTP handshake with your endpoint.
        • Port: The port for the monitor to look for a connection. The default is port 80 for HTTP. For HTTPS, use port 443.
        • Path: The specific path on the target to be monitored.
        • Header Name: (Optional) The name displayed in the request header as part of the health check. Avoid entering confidential information.
        • Header Value: (Optional) Specifies the data requested by the header. Click + Add Header to add multiple headers in succession.
        • Method: Select the HTTP method used for the health check.
        • Timeout: Select the maximum time to wait for a reply before marking the health check as failed.
        • Interval: Select the period of time between health checks of the target.
      • Ping - Enter the following:
        • Protocol: The network protocol used to interact with your endpoint, such as HTTP protocol, which initializes an HTTP handshake with your endpoint.
        • Port: If you have selected the TCP protocol, enter the port for the monitor to look for a connection. The default port is 80.
        • Timeout: Select the maximum time to wait for a reply before marking the health check as failed.
        • Interval: Select the period of time between health checks of the target.
    • Tags: If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you are not sure if you should apply tags, then skip this option (you can apply tags later) or ask your administrator.
  4. Click Create Health Check.

The health check is added to the health check list. To view more details, click the health check name. It will take a few moments for results to display once the tests have been configured.

To edit a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Select the check box for the health check you want to edit.

    Tip

    To help find a health check, you can enter the name of the health check in the Search field.
  3. Select Edit from the Actions drop-down menu.

  4. In the Edit Health Check dialog box, make the needed changes, and then click Edit Health Check.
To disable a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Select the check box for the health check you want to disable.

    Tip

    To help find a health check, you can enter the name of the health check in the Search field.
  3. Select Disable from the Actions drop-down menu.

The status of the health check changes to Disabled in the health check list.

To duplicate a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Select the check box for the health check you want to duplicate.
  3. Select Duplicate from the Actions drop-down menu.
  4. In the Create Health Check dialog box, make any updates to the duplicated health check, and then click Create Health Check.
To delete a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Select the check box for the health check you want to delete.

    Tip

    To help find a health check, you can enter the name of the health check in the Search field.
  3. Select Delete from the Actions drop-down menu.
  4. In the confirmation dialog box, click Delete.
To view the history of a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Click the name of the health check you want to view.

    The Health Check history displays a list of results for the past 90 days.

    Tip

    To help find a result, you can use the Start Date, Start Time, End Date, End Time, and Targets filter options.
  3. Click the drop-down arrow beside the Timestamp to view the monitor result details. You can use the API to download the data.
To manage tags for a health check
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. Click the name of the health check you want to view.
  3. Click the Tags tab to view or edit the existing tags. Or click Apply tag(s) to add new ones.

For more information, see Resource Tags.

To move a health check to a different compartment
  1. Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Health Checks.
  2. In the Scope section, select a compartment.
  3. Find the health check in the list, click the Actions icon (three dots), and then click Move Resource.
  4. Choose the destination compartment from the list.
  5. Click Move Resource.

For more information, see Managing Compartments.

Tip

If your health checks are continually failing, please ensure that you have permission to monitor the host and that the ports on the host have been configured to receive traffic from Health Checks.

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 the CreateHTTPMonitor operation to create a Health Check monitor that uses the HTTP protocol.
  • Use the CreatePingMonitor operation to create a Health Check monitor that uses the ping protocol.
  • Use the ListHealthChecksVantagePoints to retrieve a list of available vantage points from which to execute monitors.
  • Use the UpdateHttpMonitor operation to update the configuration of an HTTP health check monitor. You can also use this operation to disable an HTTP monitor by setting the isEnabled field to false.
  • Use the UpdatePingMonitor operation to update the configuration of ping health check monitor. You can also use this operation to disable a ping monitor by setting the isEnabled field to false.
  • Use the DeleteHttpMonitor operation to remove an HTTP health check monitor from your setup.
  • Use the DeletePingMonitor operation to remove a ping health check monitor from your setup.
  • Use the ListHttpProbeResults operation to retrieve the results of an HTTP health check monitor.
  • Use the ListPingProbeResults operation to retrieve results of a ping health check monitor.