To monitor a Hyperdisk pool's usage, review the metrics thatCompute Engine provides. This document discusses how to view metrics forpools, including Hyperdisk Exapools andHyperdisk Storage Pools.

Metrics provide information to help you perform tasks like thefollowing:

• Understand how much of the pool's capacity and performancehas been allocated to the disks in the pool.
• Understand how much of the allocated capacity and performance is being used bythe disks (available if your pool uses advancedprovisioning).
• Determine if you need to increase or decrease the pool'sprovisioned IOPS, throughput, or capacity.
• Enable notifications when certain conditions are met. For example, if thepool's utilized capacity reaches a specific value, you canuse metrics to create alerts.

Before you begin

• If you haven't already, set upauthentication. Authentication verifies your identity for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:

  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. After installation,initialize the Google Cloud CLI by running the following command:

     gcloudinit

     If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

     Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud 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.

  Install the Google Cloud CLI. After installation,initialize the Google Cloud CLI by running the following command:

  gcloudinit

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.

  For more information, seeAuthenticate for using REST in the Google Cloud authentication documentation.

Required roles and permissions

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

• Monitoring Viewer (roles/monitoring.viewer)
• To modify a metric's 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, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Retrieve and visualize metrics

You canview prebuilt charts andcreate custom charts of your pool metricsin the Google Cloud console, or inCloud Monitoring.

You can programmatically retrieve and calculate pool metricsusing any of the following methods:

• REST
• Client libraries
• Promethus Query Language (PromQL)

For a full list of pool metrics, seeAvailable metrics for Hyperdisk pools.

Prebuilt charts

You can view prebuilt charts of a pool's characteristics andperformance from the pool'sDetails page in theGoogle Cloud console. The available charts depend on the type ofpool.

To visualize a metric that isn't listed in the table, follow the stepsinCreate custom charts of pool metrics.

For descriptions of each metric, seeAvailable metrics for Hyperdisk pools.

To visualize a metric that isn't listed, follow the stepsinCreate custom charts of pool metrics.

View prebuilt charts in the Google Cloud console

To view the prebuilt charts for pool metrics in the Google Cloud console,complete the following steps.

1. In the Google Cloud console, go to theStorage pools page.

   Go to the Storage pools page

2. Select the tab forExapools orStorage Pools.

3. Click the name of the pool to open theDetails page.

4. To view the prebuilt graphs for a pool, click theMonitoring tab.

5. Optional: Reset the one hour default period to the period you wantto monitor, by choosing one of the following options:

   • 6 hours
   • 1 day
   • 1 week
   • 1 month
   • 6 weeks
   • Custom date or time range

Customize the monitoring dashboard

Use the following instructions to modify the graphs shown on thedashboard for a Hyperdisk pools.

1. In the Google Cloud console, go to theStorage pools page.

   Go to the Storage pools page

2. Select the tab forExapools orStorage Pools.

3. Click the name of a storage pool to open theDetails page.

4. Click theMonitoring tab of theManage storage pool page for aspecific pool.

5. In the list of charts that appear, find the chart with the metric that you want to review.

   • To change a prebuilt chart, clickquery_statsExplore data.

     This opens anExplore page, where you can create a customized monitoringchart or table. For information about how to create a chart fora specific metric, seeChart a single metric type.After you create a custom graph or table, you can save the result to a new orexisting custom dashboard.

     For more information about custom dashboards, seeView and customize Google Cloud dashboards.

   • To add a prebuilt chart to a custom dashboard, clickmore_vertMore chart options, then clickAdd to custom dashboard.

6. To learn how to further customize your dashboard, seeView and customize Google Cloud dashboards.

Create custom charts of pool metrics

If there is no prebuilt chart for a metric or for more complex analysis, youcan create your own charts in Metrics Explorer.Metrics Explorer lets you visualize and analyze any of thepool metrics listed inList of available metrics.You can create graphs in the Google Cloud console or using PromQL.

Example: Visualize Hyperdisk Storage Pools capacity utilization

To visualize a Storage Pools's used capacitywith a chart, complete the following steps. You can follow the same procedurefor any other metric.

1. In the Google Cloud console, go to theleaderboard Metrics explorer page:

   Go toMetrics explorer

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console, select your Google Cloud project. ForApp Hub configurations, select the App Hub host project or the app-enabled folder's management project.
3. In theMetric element, expand theSelect a metric menu, enterStorage pool in the filter bar, and then use the submenus to select a specific resource type and metric:
   1. In theActive resources menu, selectStorage pool.
   2. In theActive metric categories menu, selectStorage_pool.
   3. In theActive metrics menu, selectUsed Capacity.
   4. ClickApply.
   The fully qualified name for this metric iscompute.googleapis.com/storage_pool/used_capacity.

4. To add filters, which remove time series from the query results, use theFilter element.

5. Configure how the data is viewed. To display only the metrics for a specific pool,follow these steps:
   • In theFilter element, clickAdd filter, and then selectstorage_pool_id. For the value, enter a specific pool ID.
   • In theAggregation entry, set the first menu toUnaggregated and the second menu tostorage_pool_id.

   For more information about configuring a chart, seeSelect metrics when using Metrics Explorer.

Set up alerts for metrics

Use the following instructions to create an alert for the metric data shown onthe Storage Pool dashboard.

1. In the Google Cloud console, go to theStorage pools page.

   Go to the Storage pools page

2. Select the tab forExapools orStorage Pools.

3. Click the name of a storage pool to open theDetails page.

4. Click theMonitoring tab of theManage storage pool page for aspecific pool.

5. ClickCreate alerting policy.

   TheCreate alerting policy page appears. Configure the parameters for thealerting policy. For information about how to configure an alerting policy,seeCreate alerting policy.

What's next

• Monitor performance for individual disks byreviewing disk performance metricsandmonitoring disk health.
• Learn more aboutcreating charts with Metrics Explorer.