Instance Pool Metrics
You can monitor the health, capacity, and performance of your Compute instance pools by using metrics, alarms, and notifications.
This topic describes the metrics emitted by the metric namespace oci_instancepools.
Resources: Compute instance pools.
Overview of Metrics: oci_instancepools
The instance pool metrics help you monitor the lifecycle state of instances in your instance pools.
Required IAM Policy
To monitor resources, you must be granted the required type of access in a policy 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 both the monitoring services and the resources being monitored. If you try to perform an action and get a message that you don't have permission or are unauthorized, contact the administrator to find out what type of access you were granted and which compartment you need to work in. For more information about user authorizations for monitoring, see IAM Policies.
Available Metrics: oci_instancepools
The metrics listed in the following table are automatically available for each instance pool that you create. You do not need to enable monitoring on the instances in the pool to get these metrics.
You also can use the Monitoring service to create custom queries. See Building Metric Queries.
Depending on the metric, the following dimensions are available:
- AvailabilityDomain
- The availability domain where the instance pool resides.
- DisplayName
- The friendly name of the instance pool.
- FaultDomain
- The fault domain where the instance pool resides.
- region
- The region where the instance pool resides.
- resourceId
- The OCID of the instance pool.
| Metric | Metric Display Name | Unit | Description | Dimensions |
|---|---|---|---|---|
InstancePoolSize
|
Instance Pool Size | instances | Number of instances in the pool. |
|
ProvisioningInstances
|
Instances Provisioning | instances | Number of instances in the pool that are provisioning. |
|
RunningInstances
|
Instances Running | instances | Number of running instances in the pool. |
|
TerminatedInstances
|
Instances Terminated | instances | Number of instances in the pool that are terminating or terminated. |
|
Using the Console
- Open the navigation menu and select Compute. Under Compute, select Instance Pools.
- Click the instance pool that you're interested in.
- Under Resources, click Metrics.
-
In the Metric namespace list, select oci_instancepools.
The Metrics page displays a default set of charts for the current instance pool.
For more information about monitoring metrics and using alarms, see Overview of Monitoring. For information about notifications for alarms, see Overview of Notifications.
- Open the navigation menu and select Observability & Management. Under Monitoring, select Service Metrics.
- Select a compartment.
-
For Metric namespace, select
oci_instancepools.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 Overview of Monitoring. For information about notifications for alarms, see Overview of Notifications.
Using the API
For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)