Create and manage notification channels

Email

To add an email notification channel, do the following:

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

   Go to Alerting

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

2. In the toolbar of the Google Cloud console, select your Google Cloud project. For App Hub configurations, select the App Hub host project or the app-enabled folder's management project.
3. Click Edit notification channels .
4. In the Email section, click Add new .
5. Enter a single email address and a description.
6. Click Save .

If you use a group email address as the notification channel for an alerting policy, then configure the group to accept mail from alerting-noreply@google.com .

You can create email channels during the creation of an alerting policy. For more information, see Create a channel on demand .

Mobile App

Use the Google Cloud console Mobile App to monitor your Google Cloud console resources and Monitoring information from anywhere. Google Cloud console Mobile App notifications are either sent to a specific device or to a specific user:

• Device indicates that notifications are sent only to the specific device that created the notification channel. For device-scoped notification channels, the Display name field includes device information.
• User indicates that the notifications are sent to all of your devices that have the Google Cloud console Mobile App installed.

Cloud Monitoring determines the notification scope when the channel is created. You can't select or change the scope.

To configure a Google Cloud console Mobile App notification channel for a specific Google Cloud project, do the following:

1. Install the Google Cloud console Mobile App from your mobile device's app store.

2. Select a project for viewing in the Google Cloud console Mobile App.

   After you select a project, a data exchange between the app and the selected Google Cloud project occurs. A notification channel is created when one doesn't exist, and after a few minutes, this channel is listed under the Mobile Devices section of the Notification channels page.

To add your mobile device as a notification channel for an alerting policy, in the alerting Notificationssection, select Google Cloud console (mobile)and then choose your mobile device from the list.

PagerDuty

PagerDuty supports two-way synchronization with Monitoring. As a result, the following are true:

• If an incident is created in Monitoring, then an incident is opened in PagerDuty.
• You can't use PagerDuty to close an incident in Monitoring.
• If you resolve an incident in PagerDuty and if Monitoring has the incident open, then the incident is reopened in PagerDuty.

To set up PagerDuty notifications, do the following:

1. In your PagerDutyaccount, configure the integration in a new service or add the integration to an existing service.
   1. Create an account or sign in to an existing account.
   2. Go to the Servicespage.
   • To create a service, do the following:
     1. Click + New Service.
     2. Enter a service name and description, and then click Next.
     3. Configure an escalation policy, and then click Next.
     4. If your PagerDuty account supports incident grouping and transient alerts, configure them, and then click Next.
     5. On the integrations setup page, in the Search for an integration(s)toolbar, enter Events API v1 , and then click Create Service. You are then returned to the Integrationspanel of your new service.
   • To edit an existing service, do the following:
     1. Select a service from your Service Directory.
     2. On your service page, select the Integrationspanel.
     3. Click + Add another integrationto go to the integrations setup page.
     4. On the integrations setup page, in the Search for an integration(s)toolbar, enter Events API v1 , and then click Add. You are then returned to the Integrationspanel of your edited service.
   3. On your service's Integrationspanel, find the listing for your new integration, expand its menu, and then copy the integration key.
   4. Optional: Configure PagerDuty to accurately map incident severity values from Monitoring .
2. In Cloud Monitoring, add the PagerDuty notification channel:

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

      Go to Alerting

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

   2. In the toolbar of the Google Cloud console, select your Google Cloud project. For App Hub configurations, select the App Hub host project or the app-enabled folder's management project.
   3. Click Edit notification channels .
   4. In the PagerDutysection, click Add new.
   5. Enter the Display Name. This name should match the name of the PagerDuty service where you configured your new integration in Step 1.
   6. Paste the integration key that you copied in Step 1 into the Service Keyfield.
   7. Click Save.

When you create an alerting policy, select PagerDutyin the Notificationssection and choose your PagerDuty configuration.

The JSON packet for PagerDuty has the following format:

   
 { 
  
 "description" 
 : 
  
 A 
  
 s 
 tr 
 i 
 n 
 g 
  
 o 
 f 
  
 various 
  
 f 
 ields 
  
 i 
 n 
  
 t 
 he 
  
 i 
 n 
 cide 
 nt 
 , 
  
 "details" 
 : 
  
 JSON 
  
 payload 
  
 wi 
 t 
 h 
  
 schema 
  
 versio 
 n 
  
 1.2. 
  
 } 
 

To view an example and the schema for the details field, expand the following sections.

JSON examples

By default, the alerting backend attempts to generate a JSON packet with version 1.2 formatting. For more information about this formatting, see the next section.

The following is an example of such a packet:

 {
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}