Monitor consumption of reservations

Console

To create a Monitoring dashboard using Basic Query, follow these steps:

1. In the Google Cloud console, go to Dashboards.

   Go to Dashboards

2. Click add Create dashboard.

   The New dashboardpage opens.

3. Click add_box Add widget.

   The Add widgetpane appears.

4. Click one of the available widgets. For example, click the Linewidget.

   The Configure widgetpane appears.

5. Click Select a metric.

6. In the Select a metricwindow, do the following:

   1. Enter Reservation , and then select Reservation.

   2. In the Active metrics categorieslist, select Reservationagain.

   3. In the Active metricslist, select one of the available metrics. For example, select Used.

   4. Click Apply.

7. To filter your reservations by a specific zone, do the following:

   1. In the Add filterlist, select one of the available filters for reservations . For this example, select location.

   2. In the Comparatorlist, select one of the available operators. For this example, select = (equals)(default).

   3. In the Valuelist, select the zone you want to use to filter your reservations. For this example, select us-central1-a.

8. Click Apply.

For more options to customize Monitoring dashboards using the Google Cloud console, see Create and manage custom dashboards .

REST

To create a Monitoring dashboard using Basic Query, make a POST request to the dashboards.create method .

 POST https://monitoring.googleapis.com/v1/projects/ PROJECT_ID 
/dashboards

{
  "displayName": "Consumed reservations in zone us-central1-a",
  "mosaicLayout": {
    "columns": 12,
    "tiles": [
      {
        "height": 4,
        "widget": {
          "title": "Reservation - Used for us-central1-a [MEAN]",
          "xyChart": {
            "chartOptions": {
              "mode": "COLOR"
            },
            "dataSets": [
              {
                "minAlignmentPeriod": "60s",
                "plotType": "LINE",
                "targetAxis": "Y1",
                "timeSeriesQuery": {
                  "timeSeriesFilter": {
                    "aggregation": {
                      "alignmentPeriod": "60s",
                      "perSeriesAligner": "ALIGN_MEAN"
                    },
                    "filter": " FILTER 
",
                    "secondaryAggregation": {
                      "alignmentPeriod": "60s",
                      "perSeriesAligner": "ALIGN_NONE"
                    }
                  }
                }
              }
            ],
            "timeshiftDuration": "0s",
            "yAxis": {
              "scale": "LINEAR"
            }
          }
        },
        "width": 6
      }
    ]
  }
} 

Replace the following:

• PROJECT_ID : the project ID of the current project.

• FILTER : the Monitoring filter to use for your dashboard. For example, to monitor the consumed reservations in zone us-central1-a , specify the following:

   resource 
   . 
   type 
    
   = 
    
   'compute.googleapis.com/Reservation' 
    
   AND 
    
   metric 
   . 
   type 
    
   = 
    
   'compute.googleapis.com/reservation/used' 
    
   AND 
    
   resource 
   . 
   location 
    
   = 
    
   'us-central1-a' 
  

For more options to customize Monitoring dashboards using the Monitoring API, see Create and manage dashboards by using the API .

Console

To create a Monitoring dashboard and add a widget configured with a query using PromQL, follow these steps:

1. In the Google Cloud console, go to the Dashboards page:

   Go to Dashboards

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

2. Click add Create dashboard.

   The New dashboardpage opens.

3. Click add_box Add widget.

   The Add widgetpane appears.

4. Click one of the available widgets. For example, click the Linewidget.

   The Configure widgetpane appears.

5. If you don't see the code editor, then click code PromQLor code MQL. For Language, select PromQL.

6. In the Query editor, enter a PromQL query. For example, to view the ratio of used VMs to reserved VMs in your reservations, specify the following:

     ( 
     
    max 
     
    by 
     
    ( 
    metadata_system_name 
    ) 
     
    ( 
    { 
    "compute.googleapis.com/reservation/used" 
    } 
    ) 
     
    / 
     
    max 
     
    by 
     
    ( 
    metadata_system_name 
    ) 
     
    ( 
    { 
    "compute.googleapis.com/reservation/reserved" 
    } 
    ) 
    ) 
    
   

7. Click Run query.

8. Click Apply.

For more options to customize Monitoring dashboards using the Google Cloud console, see Create and manage custom dashboards .

REST

To create a Monitoring dashboard and add a widget configured with a query using PromQL, make a POST request to the dashboards.create method .

 POST https://monitoring.googleapis.com/v1/projects/ PROJECT_ID 
/dashboards

{
  "displayName": "Consumed reservations in zone us-central1-a",
  "mosaicLayout": {
    "columns": 12,
    "tiles": [
      {
        "height": 4,
        "widget": {
          "title": "Reservation - Used for us-central1-a [MEAN]",
          "xyChart": {
            "chartOptions": {
              "mode": "COLOR"
            },
            "dataSets": [
              {
                "plotType": "LINE",
                "targetAxis": "Y1",
                "timeSeriesQuery": {
                  "timeSeriesQueryLanguage": " PROMQL_QUERY 
"
                }
              }
            ],
            "timeshiftDuration": "0s",
            "yAxis": {
              "scale": "LINEAR"
            }
          }
        },
        "width": 6,
        "xPos": 6
      }
    ]
  }
} 

Replace the following:

• PROJECT_ID : the project ID of the current project.

• PROMQL_QUERY : the PromQL query to use for the line chart widget. For example, to view the ratio of used VMs to reserved VMs in your reservations, specify the following:

   ( 
   max 
    
   by 
    
   ( 
   metadata_system_name 
   ) 
    
   ( 
   { 
   "compute.googleapis.com/reservation/used" 
   } 
   ) 
   / 
   max 
    
   by 
    
   ( 
   metadata_system_name 
   ) 
    
   ( 
   { 
   "compute.googleapis.com/reservation/reserved" 
   } 
   ) 
   ) 
  

For more options to customize Monitoring dashboards using the Monitoring API, see Create and manage dashboards by using the API .

Console

To create a Monitoring alerting policy using Basic Query, follow these steps:

1. In the Google Cloud console, go to Alerting.

   Go to Alerting

2. Click add Create policy.

   The Create alerting policypage opens.

3. Click bar_chart Select a metric.

   The Select a metricwindow appears.

4. In the Select a metricwindow, do the following:

   1. In the Filter by resource or metric namefield, enter Reservation .

   2. If the Reservationmetric appears in the Active resourceslist, select it. Otherwise, do the following:

      1. Clear Show only active resources & metrics.

         The Inactive resourceslist appears.

      2. In the Inactive resourceslist, select Reservation.

   3. In the Active metrics categorieslist, select Reservationagain.

      The Active metricslist appears.

   4. In the Active metricslist, select one of the available metrics.

      For example, select Used.

   5. Click Apply.

5. Click add_box Add filter.

   The Add filtersection appears.

6. In the Add filtersection, do the following:

   1. In the Labellist, select one of the available filters for reservations specified in this document.

      For example, to filter your reservations by name, select name.

   2. In the Comparisonlist, select one of the available operators.

      For example, select = (equals)(default).

   3. In the Valuelist, select the name of the reservation that you want to monitor.

   4. Click Done.

7. Click Next.

   The Configure alert triggerpane appears.

8. In the Condition typessection, select one of the following options:

   1. To trigger the condition if a time series falls above or below a specific value, select Threshold.

   2. To trigger the condition if a time series doesn't have data for a specific time, select Metric absence.

   3. To trigger the condition if a time series is projected to cross the threshold in the near future, select Forecast.

   For example, select Threshold(default).

9. In the Alert triggerlist, select the condition that triggers the alert.

   For example, select Any time series violation(default).

10. In the Threshold positionlist, select when the condition triggers.

    For example, select Above threshold.

11. In the Threshold valuefield, enter a value for the condition.

    For example, enter 0 .

12. In the Condition namefield, enter a name for your condition.

    For example, enter Reservation RESERVATION_NAME consumed.

    Where RESERVATION_NAME is the name of the reservation that you specified in the previous steps.

13. Click Next.

    The Configure notifications and finalize alertpane appears.

14. Click Use notification channels.

15. In the Notification channelsfield, select the channels on which you want to be notified about the incident.

    If you have no notification channels available, click Manage notification channels, and then follow the steps to create notification channels. For more information, see Create and manage notification channels .

16. In the Incident autoclose durationfield, select a duration after which an incident is automatically closed.

    For example, select 3 days.

17. In the Alert policy namefield, enter a name for the alerting policy.

    For example, enter Alert: you started consuming reservation RESERVATION_NAME !

    Where RESERVATION_NAME is the name of the reservation that you specified in the previous steps.

18. Click Next.

    The review page of your alerting condition opens.

19. Click Create policy.

    Creating the alerting policy might take a few seconds to complete. This action redirects you to the Create alerting policypage.

For more information about the options you have when creating alerting policies using the Google Cloud console and Basic Query, see Create metric-based alert policies .

REST

To create a Monitoring alerting policy using Basic Query, make a POST request to the projects.alertPolicies.create method .

 POST https://monitoring.googleapis.com/v3/projects/ PROJECT_ID 
/alertPolicies

{
  "displayName": "Alert: you started consuming reservation RESERVATION_NAME 
!",
  "conditions": [
    {
      "displayName": "Reservation RESERVATION_NAME 
consumed.",
      "conditionThreshold": {
        "filter": " FILTER 
",
        "aggregations": [
          {
            "alignmentPeriod": "300s",
            "crossSeriesReducer": "REDUCE_NONE",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "duration": "0s",
        "trigger": {
          "count": 1
        },
        "thresholdValue": 0
      }
    }
  ],
  "alertStrategy": {
    "autoClose": " AUTO_CLOSE_TIME 
"
  },
  "combiner": "OR",
  "enabled": true,
  "notificationChannels": [
    "projects/ PROJECT_ID 
/notificationChannels/ NOTIFICATION_CHANNEL 
"
  ]
} 

Replace the following:

• PROJECT_ID : the project ID of the current project.

• RESERVATION_NAME : the name of an existing reservation which is located in the current project.

• FILTER : the Monitoring filter to use for your alerting policy. For example, to monitor the used metric for the RESERVATION_NAME reservation, specify the following:

   resource 
   . 
   type 
    
   = 
    
   'compute.googleapis.com/Reservation' 
    
   AND 
    
   metric 
   . 
   type 
    
   = 
    
   'compute.googleapis.com/reservation/used' 
    
   AND 
    
   metadata 
   . 
   system 
   . 
   name 
    
   = 
    
   ' RESERVATION_NAME 
  ' 
  

• AUTO_CLOSE_TIME : the time in seconds before an incident is automatically closed. The value must be between 0s and 604800s (7 days). For example, enter 259200s (3 days).

• NOTIFICATION_CHANNEL : the name of an existing notification channel. To set up a notification channel, see Create and manage notification channels .

For more information about the options you have when creating alerting policies using the Monitoring API and Basic Query, see Create alerting policies by using the API .

Console

To create a Monitoring alerting policy using PromQL, follow these steps:

1. In the Google Cloud console, go to Alerting.

   Go to Alerting

2. Click add Create policy.

   The Create alerting policypage opens.

3. For Policy configuration mode, select Code editor (MQL or PromQL).

   The Query editorpane appears.

4. Select PromQLas the language, and enter a PromQL query.

   For example, to create a query that groups your reservations by name and triggers an alert condition when over 90% of your reservations are consumed, enter the following query:

     ( 
     
    max 
     
    by 
     
    ( 
    metadata_system_name 
    ) 
     
    ( 
    { 
    "compute.googleapis.com/reservation/used" 
    } 
    ) 
     
    / 
     
    max 
     
    by 
     
    ( 
    metadata_system_name 
    ) 
     
    ( 
    { 
    "compute.googleapis.com/reservation/reserved" 
    } 
    ) 
    ) 
    > 
    0 
    . 
    9 
    
   

5. Click Next.

   The Configure alert triggerpane appears.

6. If the Condition name, enter a name for your condition.

   For example, enter Over 90% of your reservations are consumed.

7. Click Nextagain.

   The Configure notifications and finalize alertpane appears.

8. Click Use notification channels.

9. In the Notification channelsfield, select the channels on which you want to be notified about the incident.

   If you have no notification channels available, click Manage notification channels, and then follow the steps to create notification channels. For more information, see Create and manage notification channels .

10. In the Incident autoclose durationfield, select a duration after which an incident is automatically closed.

    For example, select 3 days.

11. In the Alert policy namefield, enter a name for the alerting policy.

    For example, enter Alert: over 90% of your reservations are consumed.

12. Click Next.

    The review page of your alerting condition opens.

13. Click Create policy.

    Creating the alerting policy might take a few seconds to complete. This action redirects you to the Create alerting policypage.

For more information about creating alerting policies using the Google Cloud console and PromQL, see Create PromQL-based alerting policies (Console) .

REST

To create a Monitoring alerting policy using PromQL, make a POST request to the projects.alertPolicies.create method .

 POST https://monitoring.googleapis.com/v3/projects/ PROJECT_ID 
/alertPolicies

{
  "displayName": "Alert: over 90% of your reservations are consumed.",
  "conditions": [
    {
      "displayName": "Over 90% of your reservations are consumed.",
      "conditionMonitoringQueryLanguage": {
        "duration": "0s",
        "trigger": {
          "count": 1
        },
        "query": " PROMQL_QUERY 
"
      }
    }
  ],
  "alertStrategy": {
    "autoClose": " AUTO_CLOSE_TIME 
"
  },
  "combiner": "OR",
  "enabled": true,
  "notificationChannels": [
    "projects/ PROJECT_ID 
/notificationChannels/ NOTIFICATION_CHANNEL 
"
  ]
} 

Replace the following:

• PROJECT_ID : the project ID of the current project.

• PROMQL_QUERY : a PromQL query to use for the alerting policy. For example, to create a query that tracks when the percentage of used VMs to reserved VMs is above 90% in the current project's reservations, specify the following:

   ( 
   max 
    
   by 
    
   ( 
   metadata_system_name 
   ) 
    
   ( 
   { 
   "compute.googleapis.com/reservation/used" 
   } 
   ) 
   / 
   max 
    
   by 
    
   ( 
   metadata_system_name 
   ) 
    
   ( 
   { 
   "compute.googleapis.com/reservation/reserved" 
   } 
   ) 
   ) 
    
   > 
    
   0 
   . 
   9 
  

• AUTO_CLOSE_TIME : the time in seconds before an incident is automatically closed. The value must be between 0s and 604800s (7 days). For example, enter 259200s (3 days).

• NOTIFICATION_CHANNEL : the name of an existing notification channel. To set up a notification channel, see Create and manage notification channels .

For more information about creating alerting policies using the Monitoring API and PromQL, see Create PromQL-based alerting policies (API) .