Oracle Cloud Infrastructure Documentation

Compute Instance Metrics

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

This topic describes the metrics emitted by the metric namespace oci_computeagent (the OracleCloudAgent software on Compute instances).

Resources: Monitoring-enabled Compute instances.

Overview of Metrics for an Instance and Related Resources

This section gives an overall picture of the different types of metrics available for an instance and its storage and network devices. See the following diagram and table for a summary.

This image shows the types of metrics available for an instance and related components.

Metric Namespace Resource ID Where Measured Available Metrics
oci_computeagent Instance OCID On the instance. The metrics in this namespace are aggregated across all the related resources on the instance. For example, DiskBytesRead is aggregated across all the instance's attached storage volumes, and NetworkBytesIn is aggregated across all the instance's attached VNICs.

See Available Metrics: oci_computeagent.

oci_blockstore Boot or block volume OCID By the Block Volume service. The metrics are for an individual volume (either boot volume or block volume). See Block Volume Metrics.
oci_vcn VNIC OCID By the Networking service. The metrics are for an individual VNIC.

See VNIC Metrics.

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.
  • Metrics exist in Monitoring: The resources that you want to monitor must emit metrics to the Monitoring service.
  • Compute instances: To emit metrics, Compute instances must be monitoring-enabled. OracleCloudAgent software installation may also be required. For more information, see Enabling Monitoring for Compute Instances.

Available Metrics: oci_computeagent

The Compute instance metrics help you measure activity level and throughput of Compute instances. The metrics listed in the following table are available for any monitoring-enabled Compute instance. You must enable monitoring on the instances to get these metrics.

The metrics in this namespace are aggregated across all the related resources on the instance. For example, DiskBytesRead is aggregated across all the instance's attached storage volumes, and NetworkBytesIn is aggregated across all the instance's attached VNICs.

You also can use the Monitoring service to create custom queries.

Each metric includes the following A qualifier provided in a metric definition. (Monitoring service.) Example: Resource identifier (resourceId), provided in the definitions of oci_computeagent metrics.

availabilityDomain
The One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, and subnets. A region contains one or more availability domains. where the instance resides.
faultDomain
The A logical grouping of hardware and infrastructure within an availability domain to provide isolation of resources in case of hardware failure or unexpected software changes. where the instance resides.
imageId
The OCID of the A template of a virtual hard drive that determines the operating system and other software for an instance. for the instance.
instancePoolId
The instance pool that the instance belongs to.
region
The A collection of availability domains located in a single geographic location. where the instance resides.
resourceDisplayName
The friendly name of the instance.
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 instance.
shape
The A template that determines the number of CPUs and the amount of memory allocated to a newly created instance. of the instance.
Metric Metric Display Name Unit Description Dimensions
CpuUtilization CPU Utilization percent Activity level from CPU. Expressed as a percentage of total time.

availabilityDomain

faultDomain

imageId

instancePoolId

region

resourceDisplayName

resourceId

shape

DiskBytesRead1, 3 Disk Read Bytes bytes Read throughput. Expressed as bytes read per interval.
DiskBytesWritten1, 3 Disk Write Bytes bytes Write throughput. Expressed as bytes written per interval.
DiskIopsRead1, 3 Disk Read I/O operations Activity level from I/O reads. Expressed as reads per interval.
DiskIopsWritten1, 3 Disk Write I/O operations Activity level from I/O writes. Expressed as writes per interval.
MemoryUtilization1 Memory Utilization percent Space currently in use. Measured by pages. Expressed as a percentage of used pages.
NetworksBytesIn1, 2 Network Receive Bytes bytes

Network receipt throughput. Expressed as bytes received.

NetworksBytesOut1, 2 Network Transmit Bytes bytes Network transmission throughput. Expressed as bytes transmitted.

Using the Console

To view default metric charts for a single Compute instance
To view default metric charts for resources related to a Compute instance
To view default metric charts for multiple Compute instances

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 following APIs for monitoring: