Review Hyperdisk Storage Pool metrics

You can view the usage metrics of your Hyperdisk Storage Pool on the Storage pools page of the Google Cloud console, or in Cloud Monitoring, Google Cloud's monitoring solution.

You can programmatically retrieve and calculate storage pool metrics using:

This document discusses the metrics Compute Engine automatically collects for each storage pool and how to view them in Cloud Monitoring.

Before you begin

If you haven't already, set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine as follows.

Select the tab for how you plan to use the samples on this page:
Console

When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
1. Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
  Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
2. Set a default region and zone.
REST

To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

Required roles and permissions

To get the permissions that you need to view metrics for a storage pool, ask your administrator to grant you the following IAM roles on the project:

Monitoring Viewer (roles/monitoring.viewer)
To modify a metrics scope, you need the following role for the scoping project and each resource container that you want to add: Monitoring Admin (roles/monitoring.admin)

For more information about granting roles, see Manage access.

You might also be able to get the required permissions through custom roles or other predefined roles.

Overview of Hyperdisk Storage Pool metrics

The Hyperdisk Storage Pool performance metrics can help you answer questions about your storage pool usage, such as the following:

Area	Query or goal	Available metrics
Storage pool characteristics	How much capacity is provisioned for the storage pool? How much IOPS or throughput is provisioned for the storage pool?	`Pool Provisioned Capacity` `Pool Provisioned IOPs` `Pool Provisioned Throughput`
Storage pool usage	How much of the capacity of the storage pools has been used? How much IOPS or throughput of the storage pools has been used?	`Pool Used Capacity` `Pool User Written Bytes` - only for Advanced capacity storage pools `Pool Used IOPS` `Pool Used Throughput`
Storage pool aggregate disk characteristics	How much capacity and performance of the storage pool has been allocated to the disks created in the storage pool?	`Total Provisioned Disk Capacity` `Total Provisioned Disk IOPS` `Total Provisioned Disk Throughput`
Storage pool utilization	What is the utilization rate for capacity in the storage pool? What is the utilization rate for IOPS or throughput in the storage pool?	`Pool Capacity Utilization (%)` `Pool IOPs Utilization (%)` `Pool Throughput Utilization (%)` `Pool Data Reduction Ratio (x:1)` - only for Advanced capacity provisioned storage pools

Available storage pool metrics

The following table lists the metrics available for Hyperdisk Storage Pools. For a full list of storage pool metrics, see Compute Engine metrics.

Each metric type in this table must be prefixed with compute.googleapis.com/, which has been omitted from the table for readability.

Display name `(Metric type)`	Description
Pool Provisioned Capacity `(storage_pool/provisioned_capacity)`	The size, in GiB, of the storage pool.
Pool Provisioned IOPS `(storage_pool/provisioned_iops)`	Provisioned IOPS of the storage pool. This metric is only valid for Hyperdisk Balanced Storage Pools.
Pool Provisioned Throughput `(storage_pool/provisioned_throughput)`	Provisioned throughput of the storage pool.
Total Provisioned Disk Capacity `(storage_pool/total_disk_provisioned_capacity)`	The sum of the capacity that is provisioned across all disks in the storage pool. A disk's provisioned capacity is the same as its total capacity. For example, a storage pool with 10 disks, each 5 TiB in size, would return 50 TiB for Total Provisioned Disk Capacity.
Max Total Provisioned Disk Capacity `(storage_pool/max_total_provisioned_disk_capacity_gb)`	Maximum allowed aggregate disk size in gibibytes (GiB).
Pool Used Capacity `(storage_pool/used_capacity)`	For Standard capacity: This is the sum of the provisioned capacity for all disks in the storage pool. This is equivalent to Total Provisioned Disk Capacity. For Advanced capacity: This is the number of bytes written to the disks in the storage pool. The value is aggregated for all disks in the storage pool, after data reduction.
Pool Used IOPS `(storage_pool/used_iops)`	The sum of IOPS provisioned for all disks in the storage pool. For Hyperdisk Balanced Storage Pools, the first 3,000 provisioned IOPS per disk are not counted towards this value.
Pool Used Throughput `(storage_pool/used_throughput)`	The sum of throughput provisioned for all disks in the storage pool, in MBps. For Hyperdisk Balanced Storage Pools, the first 140 MBps of provisioned throughput per disk are not counted towards this value.
Pool User Written Bytes `(storage_pool/pool_user_written_btyes)`	The amount of data written to disks in the storage pool, before the data is compacted.
Total Provisioned Disk IOPS `(storage_pool/total_disk_provisioned_iops)`	Sum of the provisioned IOPS for all disks in the storage pool.
Total Provisioned Disk Throughput `(storage_pool/total_disk_provisioned_throughput)`	Sum of the provisioned throughput for all disks in the storage pool, in MBps.
Pool Capacity Utilization (%) `(storage_pool/capacity_utilization)`	The used capacity of the storage pool, represented as a percentage of the overall pool capacity.
Pool IOPS Utilization (%) `(storage_pool/iops_utilization)`	The used IOPS of the storage pool, represented as a percentage of the overall pool IOPS. Use the following formula: Utilization = `(used_iops/provisioned_iops) * 100`
Pool Throughput Utilization (%) `(storage_pool/throughput_utilization)`	The used throughput of the storage pool, represented as a percentage of the overall pool throughput. Use the following formula: Utilization = `(used_throughput/provisioned_throughput) * 100`
Pool Data Reduction Ratio (x:1)	For Advanced capacity provisioned storage pools, this shows how much data reduction benefit you receive, per Pool. It's calculated using the following formula: Data reduction ratio = `(pool_user_written_btyes / used_capacity) * 100`

Review storage pool metrics

You can view the metrics for a storage pool on the Storage pools page in the console, and on the Manage storage pool page for a specific storage pool.

Go to the Storage pools page

On the Storage pools page, you can see the pool provisioned capacity and performance for each storage pool, as well as the remaining capacity and IOPS.

If you click the name of a storage pool, the Manage storage pool page opens. On this page, you can view the following:

At the top of the page are tiles that show the provisioned and used capacity, throughput, and IOPS.
In the Storage pool settings section, there is a table that shows the utilization percentages for capacity, IOPS, and throughput.

Visualize storage pool metrics on a chart

You can visualize the storage pool metrics by plotting any of the metrics listed previously with Metrics Explorer. Metrics Explorer is part of Cloud Monitoring.

Example: Visualize storage pool capacity utilization

To visualize the storage pool used capacity on a chart, follow these instructions. You can follow the same procedure for the other storage pool metrics.

In the navigation panel of the Google Cloud console, select Monitoring, and then select Metrics explorer:
Go to Metrics explorer
In the Metric element, expand the Select a metric menu, enter Storage Pool in the filter bar, and then use the submenus to select a specific resource type and metric:
1. In the Active resources menu, select Storage Pool.
2. In the Active metric categories menu, select Storage_pool.
3. In the Active metrics menu, select Used Capacity.
4. Click Apply.
The fully qualified name for this metric is compute.googleapis.com/storage_pool/used_capacity.
Configure how the data is viewed. To display only the metrics for a specific storage pool, follow these steps:
- In the Filter element, click Add filter, and then select storage_pool_id. For the value, enter a specific storage pool ID.
- In the Aggregation entry, set the first menu to Unaggregated and the second menu to storage_pool_id.
For more information about configuring a chart, see Select metrics when using Metrics Explorer.

What's next

Enable the Monitoring API.
View all the available metrics for Compute Engine.
Learn more about creating charts with Metric Explorer.
Learn more about Cloud Monitoring.
Learn more about storage pools.