OCI Compute
Introduction
Oracle Cloud Infrastructure (OCI) Compute is a fully managed, scalable, and highly available service that enables users to create, deploy, and manage virtual machines and workloads efficiently. OCI Compute provides security, traffic management, and monitoring capabilities to support various cloud computing requirements.
Getting Started
Compatibility
vuSmartMaps supports the monitoring of OCI Compute for availability, cpu utilisation, memory utilisation, disk and network usage.
Data Collection Method
vuSmartMaps collects OCI Compute metrics using an internal data collector. This agent collects data based on the source configuration.
Prerequisites
Dependent Configuration
To configure this O11ySource, create a 'credential' of type 'oci' under the 'Definition' tab.
Inputs for Configuring Data Source
- Compartment ID: The unique identifier (OCID) of the compartment in which your API Gateway resources are located.
- Region: The OCI region where your resources are located.
- Credential: The tenancy, user, and PEM file required for authentication with OCI.
- Interval (in minutes): Time interval for polling data from the OCI Gateway. Period should be between 5m – 60m.
- Rate Limit: The Maximum requests per second. Note that the global default OCI rate limit is 5 reqs/sec.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| vuSmartMaps IP | OCI Compute ListMetrics and SummarizeMetricsData API | 443* | TCP | Outbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
The User account provided in the configuration must have the minimum permissions listed below to collect metrics for all OCI Compute servers:
Allow group <group name> to inspect metrics in compartment <compartment name>Allow group <group name> to read metrics in compartment <compartment name>
Configuration Steps
- Before configuring OCI Compute, you must create a 'credential' of type 'OCI' under 'Definition' tab:
- *Name: The name of the credentials.
- *Tenancy: The OCID of your OCI tenancy, which acts as the root container for all your OCI resources.
- *User: The OCID of the user that will be used for authentication in API requests.
- *Fingerprint: A unique identifier for the public key associated with the API signing key of the user.
- *Private Key File: RSA key pair in string format. You can use the following command to convert the PEM format file into a single line string.
awk 'NF {sub(/\r/, """"); printf ""%s\\n"",$0;}' <path to API Key>Enable+Save
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| timestamp | Timestamp of the metric collection | DateTime64 |
| tenant_id | Tenant identifier | String |
| bu_id | Business unit identifier | String |
| interval | Collection interval in seconds | UInt32 |
| cpu_utilization_count | Count of CPU utilization measurements | UInt32 |
| cpu_utilization_last | Last measured CPU utilization value | Float64 |
| cpu_utilization_max | Maximum CPU utilization in interval | Float64 |
| cpu_utilization_mean | Average CPU utilization in interval | Float64 |
| cpu_utilization_min | Minimum CPU utilization in interval | Float64 |
| cpu_utilization_sum | Sum of CPU utilization measurements | Float64 |
| disk_bytes_read_count | Count of disk read measurements | UInt32 |
| disk_bytes_read_last | Last measured disk bytes read | UInt64 |
| disk_bytes_read_max | Maximum disk bytes read in interval | UInt64 |
| disk_bytes_read_mean | Average disk bytes read in interval | Float64 |
| disk_bytes_read_min | Minimum disk bytes read in interval | UInt64 |
| disk_bytes_read_sum | Sum of disk bytes read measurements | UInt64 |
| disk_bytes_written_count | Count of disk write measurements | UInt32 |
| disk_bytes_written_last | Last measured disk bytes written | UInt64 |
| disk_bytes_written_max | Maximum disk bytes written in interval | UInt64 |
| disk_bytes_written_mean | Average disk bytes written in interval | Float64 |
| disk_bytes_written_min | Minimum disk bytes written in interval | UInt64 |
| disk_bytes_written_sum | Sum of disk bytes written measurements | UInt64 |
| disk_iops_read_count | Count of disk read IOPS measurements | UInt32 |
| disk_iops_read_last | Last measured disk read IOPS | UInt64 |
| disk_iops_read_max | Maximum disk read IOPS in interval | UInt32 |
| disk_iops_read_mean | Average disk read IOPS in interval | Float64 |
| disk_iops_read_min | Minimum disk read IOPS in interval | UInt32 |
| disk_iops_read_sum | Sum of disk read IOPS measurements | UInt32 |
| disk_iops_written_count | Count of disk write IOPS measurements | UInt32 |
| disk_iops_written_last | Last measured disk write IOPS | UInt64 |
| disk_iops_written_max | Maximum disk write IOPS in interval | UInt32 |
| disk_iops_written_mean | Average disk write IOPS in interval | Float64 |
| disk_iops_written_min | Minimum disk write IOPS in interval | UInt32 |
| disk_iops_written_sum | Sum of disk write IOPS measurements | UInt32 |
| load_average_count | Count of load average measurements | UInt32 |
| load_average_last | Last measured load average | Float64 |
| load_average_max | Maximum load average in interval | Float64 |
| load_average_mean | Average load average in interval | Float64 |
| load_average_min | Minimum load average in interval | Float64 |
| load_average_sum | Sum of load average measurements | Float64 |
| memory_allocation_stalls_count | Count of memory allocation stall measurements | UInt32 |
| memory_allocation_stalls_last | Last measured memory allocation stalls | UInt32 |
| memory_allocation_stalls_max | Maximum memory allocation stalls in interval | UInt32 |
| memory_allocation_stalls_mean | Average memory allocation stalls in interval | Float64 |
| memory_allocation_stalls_min | Minimum memory allocation stalls in interval | UInt32 |
| memory_allocation_stalls_sum | Sum of memory allocation stall measurements | UInt32 |
| memory_utilization_count | Count of memory utilization measurements | UInt32 |
| memory_utilization_last | Last measured memory utilization | Float64 |
| memory_utilization_max | Maximum memory utilization in interval | Float64 |
| memory_utilization_mean | Average memory utilization in interval | Float64 |
| memory_utilization_min | Minimum memory utilization in interval | Float64 |
| memory_utilization_sum | Sum of memory utilization measurements | Float64 |
| networks_bytes_in_count | Count of network inbound measurements | UInt32 |
| networks_bytes_in_last | Last measured network bytes in | UInt64 |
| networks_bytes_in_max | Maximum network bytes in in interval | UInt64 |
| networks_bytes_in_mean | Average network bytes in in interval | Float64 |
| networks_bytes_in_min | Minimum network bytes in in interval | UInt64 |
| networks_bytes_in_sum | Sum of network bytes in measurements | UInt64 |
| networks_bytes_out_count | Count of network outbound measurements | UInt32 |
| networks_bytes_out_last | Last measured network bytes out | UInt64 |
| networks_bytes_out_max | Maximum network bytes out in interval | UInt64 |
| networks_bytes_out_mean | Average network bytes out in interval | Float64 |
| networks_bytes_out_min | Minimum network bytes out in interval | UInt64 |
| networks_bytes_out_sum | Sum of network bytes out measurements | UInt64 |
| instance_metadata_requests_count | Count of instance metadata request measurements | UInt32 |
| instance_metadata_requests_last | Last measured instance metadata requests | UInt32 |
| instance_metadata_requests_max | Maximum instance metadata requests in interval | UInt32 |
| instance_metadata_requests_mean | Average instance metadata requests in interval | Float64 |
| instance_metadata_requests_min | Minimum instance metadata requests in interval | UInt32 |
| instance_metadata_requests_sum | Sum of instance metadata request measurements | UInt32 |
| instance_accessibility_status_count | Count of instance accessibility status measurements | UInt32 |
| instance_accessibility_status_last | Last measured instance accessibility status | UInt32 |
| instance_accessibility_status_max | Maximum instance accessibility status in interval | UInt32 |
| instance_accessibility_status_mean | Average instance accessibility status in interval | Float64 |
| instance_accessibility_status_min | Minimum instance accessibility status in interval | UInt32 |
| instance_accessibility_status_sum | Sum of instance accessibility status measurements | UInt32 |
| instance_file_system_status_count | Count of file system status measurements | UInt32 |
| instance_file_system_status_last | Last measured file system status | UInt32 |
| instance_file_system_status_max | Maximum file system status in interval | UInt32 |
| instance_file_system_status_mean | Average file system status in interval | Float64 |
| instance_file_system_status_min | Minimum file system status in interval | UInt32 |
| instance_file_system_status_sum | Sum of file system status measurements | UInt32 |
| instance_status_count | Count of instance status measurements | UInt32 |
| instance_status_last | Last measured instance status | UInt32 |
| instance_status_max | Maximum instance status in interval | UInt32 |
| instance_status_mean | Average instance status in interval | Float64 |
| instance_status_min | Minimum instance status in interval | UInt32 |
| instance_status_sum | Sum of instance status measurements | UInt32 |
| maintenance_status_count | Count of maintenance status measurements | UInt32 |
| maintenance_status_last | Last measured maintenance status | UInt32 |
| maintenance_status_max | Maximum maintenance status in interval | UInt32 |
| maintenance_status_mean | Average maintenance status in interval | Float64 |
| maintenance_status_min | Minimum maintenance status in interval | UInt32 |
| maintenance_status_sum | Sum of maintenance status measurements | UInt32 |
| instance_pool_size_count | Count of instance pool size measurements | UInt32 |
| instance_pool_size_last | Most recent instance pool size value | UInt32 |
| instance_pool_size_max | Maximum value of instance pool size | UInt32 |
| instance_pool_size_mean | Average (mean) instance pool size | Float64 |
| instance_pool_size_min | Minimum value of instance pool size | UInt32 |
| instance_pool_size_sum | Total sum of instance pool size values | UInt32 |
| provisioning_instances_count | Count of provisioning instances measurements | UInt32 |
| provisioning_instances_last | Most recent number of provisioning instances | UInt32 |
| provisioning_instances_max | Maximum number of provisioning instances observed | UInt32 |
| provisioning_instances_mean | Average (mean) number of provisioning instances | Float64 |
| provisioning_instances_min | Minimum number of provisioning instances observed | UInt32 |
| provisioning_instances_sum | Total sum of provisioning instances values | UInt32 |
| running_instances_count | Count of running instances measurements | UInt32 |
| running_instances_last | Most recent number of running instances | UInt32 |
| running_instances_max | Maximum number of running instances observed | UInt32 |
| running_instances_mean | Average (mean) number of running instances | Float64 |
| running_instances_min | Minimum number of running instances observed | UInt32 |
| running_instances_sum | Total sum of running instances values | UInt32 |
| terminated_instances_count | Count of terminated instances measurements | UInt32 |
| terminated_instances_last | Most recent number of terminated instances | UInt32 |
| terminated_instances_max | Maximum number of terminated instances observed | UInt32 |
| terminated_instances_mean | Average (mean) number of terminated instances | Float64 |
| terminated_instances_min | Minimum number of terminated instances observed | UInt32 |
| terminated_instances_sum | Total sum of terminated instances values | UInt32 |
| name | Name of the compute instance | String |
| availability_domain | OCI availability domain | String |
| compartment_id | OCI compartment identifier | String |
| dedicated_vm_host_id | Dedicated VM host identifier | String |
| fault_domain | OCI fault domain | String |
| host | Host identifier | String |
| image_id | OS image identifier | String |
| instance_pool_id | Instance pool identifier | String |
| region | OCI region | String |
| resource_display_name | Friendly display name of the resource | String |
| resource_id | Unique resource identifier | String |
| shape | Compute instance shape/size | String |
| display_name | Friendly display name of the instance pool | String |
