Oracle Cloud Infrastructure Documentation

Health Checks Metrics

You can monitor the health, capacity, and performance of your health checks by using metrics, alarms, and notifications.

This topic describes the metrics emitted by the metric namespace oci_healthchecks (the Health Checks service).

Overview of the Health Checks Service Metrics

Oracle Cloud Infrastructure Health Checks provides users with high frequency external monitoring to determine the availability and performance of any publicly facing service, including hosted websites, API endpoints, or externally facing load balancers. The Health Checks service metrics help you monitor the performance of your endpoints over a 24 hour period.

Prerequisites

  • IAM policies: To monitor resources, you must be given the required type of access in a An IAM document that specifies who has what type of access to your resources. It is used in different ways: to mean an individual statement written in the policy language; to mean a collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it); and to mean the overall body of policies your organization uses to control access to resources. written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. 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 A collection of related resources that can be accessed only by certain groups that have been given permission by an administrator in your organization. you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.

Available Metrics: oci_healthchecks

The metrics listed in the following table are automatically available for each health check that you create. You do not need to enable monitoring on the health check to get these metrics.

Each metric includes the following dimensions:

resourceID
The An Oracle-assigned unique ID called an Oracle Cloud Identifier (OCID). This ID is included as part of the resource's information in both the Console and API. of the policy to which the metric applies.

 

Metric Metric Display Name Unit Description Dimensions
BasicCount Basic Health Checks count The total number of active basic health checks.

resourceID

resourceDisplayName

PremiumCount Premium Health Checks count

The total number of active premium health checks.

HTTP.StatusCode HTTP(S) Response Status Code count The HTTP response code.

target

vantagePoint

resourceId

resourceDisplayName

statusCode2xx

statusCode3xx

statusCode4xx

statusCode5xx

protocol

errorMessage

PING.isHealthy Success Rate of Ping Test percent Displays availability of end point being monitored.

target

vantagePoint

resourceId

resourceDisplayName

protocol

errorMessage

icmpCode

HTTP.DNSLookupTime HTTP(S) DNS Lookup Time ms

The time taken for domain name lookup in milliseconds.

target

vantagePoint

resourceId

resourceDisplayName

protocol

errorMessage

HTTP.TCPConnectTime.Full HTTP(S) Connection Duration ms The total duration in milliseconds from start of the request until response is fully consumed or the connection is closed.
HTTP.TCPConnectTime.SSL HTTP(S) Secure Connection Duration ms The total duration in milliseconds from start of secure connection to end of connection.
HTTP.RequestTime HTTP(S) Request Duration ms The total duration of the request in milliseconds.
HTTP.ResponseTime HTTP(S) Response Duration ms The total duration of response in milliseconds.
HTTP.TotalDuration HTTP(S) Total Duration ms The total duration of the test run in milliseconds.
HTTP.isHealthy Success Rate of HTTP(S) Test percent Displays if the end point being monitored is up or down.
PING.Latency Ping Latency Measurement ms Latency measurement for ping test in milliseconds.

Using the Console

To view metric charts for resources related to a health check monitor
To view health check metric charts using monitoring

For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.

Using the API

Use the following APIs for monitoring: