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).
You can view these metrics for individual Compute instances, and for all the instances in an instance pool.
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.
| 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. |
|
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 (Monitoring service) A qualifier provided in a metric definition. 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. For instance pools, the value is averaged across all instances in the pool. |
|
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. For instance pools, the value is averaged across all instances in the pool. |
|
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. | |
|
1This metric is a cumulative counter that shows monotonically increasing behavior for each session of the OracleCloudAgent software, resetting when the operating system is restarted. 2The Networking service provides additional metrics (in the 3The Block Volume service provides additional metrics (in the |
||||
Using the Console
- Open the navigation menu. Under Core Infrastructure, go to Compute and click Instances.
- Click the instance that you're interested in.
- Under Resources, click Metrics. If this is a bare metal instance, in the Metric Namespace list, select oci_computeagent.
The Metrics page displays a default set of charts for the current instance.
Not seeing any metric charts for the instance?If you don't see any metric charts, your Compute instance might not be emitting metrics. See the following possible causes and resolutions.
Possible cause How to check Resolution Monitoring is disabled on the instance. Review the instance configuration. Enable monitoring. No OracleCloudAgent software exists on the instance (occurs with older images). Connect to the instance and look for the software. Install the software. The instance cannot access theMonitoring service because its VCN does not use the Internet. Review the instance's IP address. If it's not public, then a service gateway is needed. Set up a service gateway. The instance does not use a supported image. Review Supported Images. Create an instance with a supported image. New instance in a new A collection of related resources that can be accessed only by certain groups that have been given permission by an administrator in your organization.: The IAM 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. required for the instance to publish metrics to Monitoring are not yet initialized.
More information: IAM policies are automatically created for new instances and are immediately available, unless the instances are in a new compartment. For a new instance in a new compartment, the policies can take up to 20 minutes to initialize, which delays the emission of metrics.
(not applicable) Check back after 10 or 20 minutes.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
- For an attached block volume: While viewing the instance's details, click Attached Block Volumes, and then click the volume you're interested in. Click Metrics to see the volume's charts. For more information about the emitted metrics, see Block Volume Metrics.
- For the attached boot volume: While viewing the instance's details, click Boot Volume, and then click the volume you're interested in. Click Metrics to see the volume's charts. For more information about the emitted metrics, see Block Volume Metrics.
- For an attached VNIC: While viewing the instance's details, click Attached VNICs, and then click the VNIC you're interested in. Click Metrics to see the charts for the VNIC. For more information about the emitted metrics, see Networking Metrics.
- Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
- Select a compartment.
-
For Metric Namespace, select oci_computeagent.
The Service Metrics page dynamically updates the page to show charts for each metric that is emitted by the selected metric namespace.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
- Open the navigation menu. Under Core Infrastructure, go to Compute and click Instance Pools.
- Click the instance pool that you're interested in.
-
Under Resources, click Metrics.
The Metrics page displays a default set of charts for the current instance pool.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
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:
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)