Questa pagina è stata tradotta dall'API Cloud Translation.

Creare e gestire i canali di notifica

Questo documento descrive come configurare i canali di notifica utilizzando la console Google Cloud. Cloud Monitoring utilizza questi canali per inviare una notifica a te o al tuo team di assistenza quando viene attivato un criterio di avviso. Quando crei un criterio di avviso, selezioni chi riceve le notifiche effettuando delle scelte dall'elenco di canali di notifica configurati. Ad esempio, potresti configurare criteri di avviso che monitorano le istanze Compute Engine per pubblicare un argomento Pub/Sub e inviare una notifica al canale Slack del team di guardia.

Per ulteriori informazioni, consulta Latenza delle notifiche e Notifiche per incidente.

Questo documento descrive come utilizzare la console Google Cloud. Se utilizzi l'API Cloud Monitoring, consulta Creare e gestire i canali di notifica tramite API.

Prima di iniziare

Per ottenere le autorizzazioni necessarie per visualizzare e configurare i canali di notifica utilizzando la console Google Cloud, chiedi all'amministratore di concederti il ruolo IAM Editor di monitoraggio (roles/monitoring.editor) nel tuo progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Per ulteriori informazioni sui ruoli di Cloud Monitoring, consulta Controllare l'accesso con Identity and Access Management.

Creazione di un canale di notifica

Quando crei un criterio di avviso, puoi selezionare qualsiasi canale di notifica configurato e aggiungerlo al criterio. Puoi preconfigurare i canali di notifica o configurarli durante la procedura di creazione di un criterio di avviso. Per ulteriori informazioni, consulta Creare un canale on demand.

Per creare un canale di notifica utilizzando la console Google Cloud, segui le istruzioni specifiche del canale riportate nella tabella seguente:

Email

Per aggiungere un canale di notifica via email:

Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic su Modifica canali di notifica.
Nella sezione Email, fai clic su Aggiungi nuova.
Inserisci un singolo indirizzo email e una descrizione.
Fai clic su Salva.

Se utilizzi un indirizzo email di gruppo come canale di notifica per un criterio di avviso, configura il gruppo in modo che accetti la posta da alerting-noreply@google.com.

Puoi creare canali email durante la creazione di un criterio di avviso. Per ulteriori informazioni, consulta Creare un canale on demand.

App per dispositivi mobili

Utilizza l'app mobile della console Google Cloud per monitorare le risorse della console Google Cloud e le informazioni di monitoraggio da qualsiasi luogo. Le notifiche dell'app mobile Cloud Console vengono inviate a un dispositivo o a un utente specifico:

Elenco dei canali di notifica dell'app mobile della console Google Cloud.

Dispositivo indica che le notifiche vengono inviate solo al dispositivo specifico che ha creato il canale di notifica. Per i canali di notifica basati sul dispositivo, il campo Nome visualizzato include le informazioni del dispositivo.
Utente indica che le notifiche vengono inviate a tutti i tuoi dispositivi su cui è installata l'app mobile Google Cloud Console.

Cloud Monitoring determina l'ambito delle notifiche al momento della creazione del canale. Non puoi selezionare o modificare l'ambito.

Per configurare un canale di notifica per app mobile della console Google Cloud per un progetto Google Cloud specifico, procedi nel seguente modo:

Installa l'app mobile Google Cloud Console dall'app store del tuo dispositivo mobile.
Seleziona un progetto da visualizzare nell'app mobile della console Google Cloud.

Dopo aver selezionato un progetto, avviene uno scambio di dati tra l'app e il progetto Google Cloud selezionato. Se non esiste un canale di notifica, viene creato uno nuovo e dopo alcuni minuti viene visualizzato nella sezione Dispositivi mobili della pagina Canali di notifica.

Per aggiungere il tuo dispositivo mobile come canale di notifica per un criterio di avviso, nella sezione Notifiche degli avvisi, seleziona Console Google Cloud (dispositivo mobile) e poi scegli il tuo dispositivo mobile dall'elenco.

PagerDuty

PagerDuty supporta la sincronizzazione bidirezionale con Monitoring. Di conseguenza, quanto segue è vero:

Se viene creato un incidente in Monitoring, viene aperto un incidente in PagerDuty.
Non puoi utilizzare PagerDuty per chiudere un incidente in monitoring.
Se risolvi un incidente in PagerDuty e se il monitoraggio ha aperto l'incidente, questo viene nuovamente aperto in PagerDuty.

Per configurare le notifiche di PagerDuty:

Nel tuo account PagerDuty, configura l'integrazione in un nuovo servizio o aggiungila a un servizio esistente.
1. Crea un account o accedi a un account esistente.
2. Vai alla pagina Servizi.
3. Nel riquadro Integrations (Integrazioni) del tuo servizio, trova la scheda della nuova integrazione, espandi il relativo menu e poi copia la chiave di integrazione.
4. (Facoltativo) Configura PagerDuty in modo da mappare con precisione i valori della gravità degli incidenti provenienti da Monitoring.
In Cloud Monitoring, aggiungi il canale di notifica PagerDuty:
1. Nella console Google Cloud, vai alla pagina Avvisi:
  Vai ad Avvisi
  
  Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
2. Fai clic su Modifica canali di notifica.
3. Nella sezione PagerDuty, fai clic su Aggiungi nuovo.
4. Inserisci il Nome visualizzato. Questo nome deve corrispondere al nome del servizio PagerDuty in cui hai configurato la nuova integrazione nel passaggio 1.
5. Incolla la chiave di integrazione che hai copiato nel passaggio 1 nel campo Chiave del servizio.
6. Fai clic su Salva.

Quando crei un criterio di avviso, seleziona PagerDuty nella sezione Notifiche e scegli la configurazione di PagerDuty.

Il pacchetto JSON per PagerDuty ha il seguente formato:

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

Per visualizzare un esempio e lo schema per il campo details, espandi le seguenti sezioni.

Esempi di JSON

Per impostazione predefinita, il backend di avviso tenta di generare un pacchetto JSON con la formattazione della versione 1.2. Per ulteriori informazioni su questa formattazione, consulta la sezione successiva.

Di seguito è riportato un esempio di questo tipo di pacchetto:


{
  "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"
}

Struttura dello schema, versione 1.2

Questa sezione descrive la versione 1.2 dello schema del payload. Alcuni campi potrebbero non essere visualizzati in tutti i pacchetti restituiti o avere valori vuoti, a seconda della configurazione del criterio di avviso, dello stato dell'incidente o della risorsa monitorata. Alcuni campi accettano strutture incorporate come valori. Queste strutture sono descritte per riferimento perché i relativi contenuti possono variare.

In un pacchetto restituito, i campi possono essere presenti in qualsiasi ordine. Nella descrizione che segue, sono organizzati in gruppi correlati.

{
  "version": "1.2",
  "incident": {

    Informazioni sull'incidente.

    "incident_id": una stringa che rappresenta l'ID generato per questo incidente.
    "scoping_project_id": una stringa, l'ID progetto che ospita l'ambito delle metriche.
    "scoping_project_number": number, il numero del progetto di definizione dell'ambito.
    "url": stringa, URL della console Google Cloud per questo incidente.
    "started_at": numero, ora (in secondi Unix epoch) in cui è stato aperto l'incidente.
    "ended_at": numero, ora (in secondi Unix epoch) in cui l'incidente è stato chiuso. Viene compilato solo quando state è closed.
    "state": stato dell'incidente: open o closed. Se open, ended_at è null.
    "summary": una stringa, il riepilogo testuale dell'incidente generato.
    "apigee_url": stringa, URL Apigee per questo incidente, solo per i tipi di risorse Apigee Environment e Proxy*.
    "observed_value": una stringa, il valore osservato che ha attivato/risolto l'avviso, può essere vuota se la condizione è scaduta.

    Informazioni sulla risorsa monitorata per la quale è stato aperto l'incidente.

    "resource": {
      "type": stringa, identificatore del tipo di risorsa monitorata per cui viene generato l'avviso, ad esempio gce_instance; consulta Elenco delle risorse monitorate.
      "labels": coppia chiave-valore per le etichette associate alla risorsa monitorata.
    },
    "resource_type_display_name": una stringa, il nome visualizzato del tipo di risorsa monitorata.
    "resource_id": stringa, ID istanza della risorsa monitorata, stesso valore di resource.labels.instance_id.
    "resource_display_name": stringa, nome visualizzato della risorsa monitorata.
    "resource_name": stringa, nome generato di questa risorsa monitorata; è costituito da valori di altri campi.

    Informazioni sul tipo di metrica dei dati delle serie temporali.

    "metric": {
      "type": una stringa, l'identificatore del tipo di metrica per cui viene generato l'avviso, ad esempio compute.googleapis.com/instance/cpu/utilization; consulta l'elenco delle metriche.
      "displayName": una stringa, il nome visualizzato del tipo di metrica.
      "labels": oggetto, coppie chiave-valore per le etichette associate alla metrica.
    },
    "metadata": {
      "system_labels": coppie chiave-valore per le etichette dei metadati di sistema.
      "user_labels": coppia chiave-valore per le etichette dei metadati utente.
    },

    Informazioni sul criterio di avviso e sulla condizione che hanno aperto/risolto l'incidente.
    I valori vengono estratti dall'oggetto AlertPolicy pertinente.

    "policy_name": una stringa, il nome visualizzato per il criterio di avviso.
    "policy_user_labels": coppia chiave-valore per le eventuali etichette utente associate al criterio.
    "documentation": un oggetto, una struttura incorporata del modulo Documentation.
    "condition": un oggetto, una struttura incorporata del modulo Condition.
    "condition_name": una stringa, il nome visualizzato della condizione, lo stesso valore di condition.displayName.
    "severity": livello di gravità degli incidenti. Se questo campo non è definito durante la creazione del criterio di avviso, Cloud Monitoring imposta la gravità del criterio di avviso su no severity.
    "threshold_value": una stringa, il valore soglia di questa condizione, può essere vuota se la condizione non è una condizione soglia.
  },
}

Norme sul ritiro

Lo schema del payload è soggetto alle norme sul ritiro di Google Cloud descritte nella Sezione 1.4(d) dei Termini di servizio della piattaforma Google Cloud. Tieni presente che lo schema non controlla i formati dei valori dei campi generati e che questi formati possono cambiare senza preavviso. Ad esempio, incident.summary, incident.documentation.content e incident.url devono includere i dati relativi ai rispettivi campi, ma lo schema non ha vincoli per garantire l'analisi accurata di questi campi. Puoi utilizzare il valore nel suo complesso e presumere che rispetti le norme relative al ritiro, ma non fare affidamento sull'analisi dei campi generati.

Configura PagerDuty per mappare i livelli di gravità

Per impostazione predefinita, le notifiche di PagerDuty mostrano tutti i livelli di gravità degli incidenti come "critici". Puoi configurare le regole di orchestrazione degli eventi in PagerDuty in modo che la gravità dell'avviso PagerDuty corrisponda alla gravità dell'incidente di monitoraggio:

Nel tuo account PagerDuty, vai alla pagina Servizi.
Seleziona il servizio PagerDuty in cui ricevi le notifiche di Google Cloud.
Fai clic su Impostazioni.
Vai alla sezione Gestione eventi e fai clic su Visualizza regole di orchestrazione.
Fai clic su Nuova regola.
Per ogni valore di gravità del monitoraggio che vuoi convertire, crea una regola condizionale che mappa il valore di gravità a un valore PagerDuty equivalente:
1. Nel menu in Passaggio 1: quando deve essere applicata questa regola?, Seleziona Se gli eventi corrispondono a determinate condizioni.
2. Seleziona l'editor di codice.
3. Nella sezione Se, inserisci event.custom_details.incident.severity matches part 'VALUE', dove VALUE è il nome di un valore di gravità del monitoraggio, quindi fai clic su Avanti.
4. In Passaggio 2: quali azioni devono essere applicate, seleziona Dati dell'avviso.
5. Imposta la gravità dell'avviso su un valore corrispondente al valore di monitoraggio inserito nel passaggio C, quindi salva le modifiche.
(Facoltativo) Per aggiungere altre regole, fai clic su Regola Else.

SMS

Per configurare le notifiche SMS:

Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic su Modifica canali di notifica.
Nella sezione SMS, fai clic su Aggiungi nuovo.
Completa la finestra di dialogo e fai clic su Salva.

Quando configuri il criterio di avviso, seleziona il tipo di notifica SMS e scegli un numero di telefono verificato dall'elenco.

Slack

L'integrazione di Monitoring con Slack consente ai tuoi criteri di avviso di pubblicare in un canale Slack quando viene creato un nuovo incidente. Per configurare le notifiche di Slack:

In Slack: crea uno spazio di lavoro e un canale Slack sul sito di Slack. Registra l'URL del canale.
Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic su Modifica canali di notifica.
Nella sezione Slack, fai clic su Aggiungi nuovo per aprire la pagina di accesso a Slack:
1. Seleziona il tuo spazio di lavoro di Slack.
2. Fai clic su Consenti per consentire a Cloud Monitoring di accedere alla tua area di lavoro Slack. Questa azione ti riporta alla pagina di configurazione del monitoraggio per il tuo canale di notifica.
3. Nel campo Nome canale Slack, inserisci il nome del canale Slack che vuoi utilizzare per le notifiche.
4. Nel campo Nome visualizzato di Cloud Alerting, inserisci una breve dichiarazione descrittiva. Il monitoraggio mostra il valore di questo campo nella pagina Canale di notifiche.
5. (Facoltativo) Per testare la connessione tra Cloud Monitoring e la tua area di lavoro Slack, fai clic su Invia notifica di test. Se la connessione va a buon fine, viene visualizzato un messaggio This is a test alert notification... nel canale di notifica di Slack che hai specificato. Controlla il canale di notifica per confermare la ricezione.
Se il canale Slack che vuoi utilizzare per le notifiche è un canale privato, devi invitare manualmente l'app di monitoraggio al canale:
1. Apri Slack.
2. Vai al canale specificato come canale di notifica per il monitoraggio.
3. Invita l'app di monitoraggio al canale inserendo e inviando il seguente messaggio:
```
/invite @Google Cloud Monitoring
```
  Assicurati di invitare l'app Monitoraggio al canale privato specificato durante la creazione del canale di notifica in Monitoraggio. L'invito dell'app di monitoraggio ai canali pubblici è facoltativo.
Quando crei un criterio di avviso, seleziona Slack nella sezione Notifiche e scegli la configurazione di Slack.

Webhook

Prima di configurare un canale di notifica Webhook, tieni presente quanto segue:

Gli webhook supportano solo gli endpoint pubblici. Se devi inviare notifiche a un endpoint non pubblico, crea un canale di notifica Pub/Sub e configura un abbonamento all'argomento Pub/Sub. Per ulteriori informazioni, consulta Le notifiche webhook non vanno a buon fine quando sono configurate per un endpoint privato.
Se una funzione Cloud Run è configurata come endpoint webhook per un canale di notifica, assicurati che l'utente che richiama la funzione disponga dell'autorizzazione di autenticazione richiesta. Per ulteriori informazioni, consulta Eseguire l'autenticazione per l'invocazione e Attivare l'accesso a una funzione.
I canali di notifica Webhook non sono compatibili con Microsoft Teams. Per inviare i dati di notifica dal monitoraggio a Microsoft Teams, crea un livello di integrazione per ricevere l'webhook di monitoraggio e poi reindirizzarlo a Microsoft Teams.

Configurare i canali di notifica webhook

Per configurare le notifiche Webhook:

Il gestore del webhook: identifica l'URL dell'endpoint pubblico per ricevere i dati del webhook da Monitoraggio.
Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic su Modifica canali di notifica.
Nella sezione Webhook, fai clic su Aggiungi nuovo.
Completa la finestra di dialogo.
Fai clic su Test Connection (Prova connessione) per inviare un payload di test all'endpoint Webhook. Puoi andare all'endpoint di ricezione per verificare la consegna.
Fai clic su Salva.

Quando crei un criterio di avviso, seleziona Webhook nella sezione Notifiche e scegli la configurazione del webhook. Le notifiche inviate da Error Reporting rispettano lo schema 1.0 mentre quelle inviate da Monitoring rispettano lo schema 1.2:

Esempi di JSON

Di seguito è riportato un esempio di questo tipo di pacchetto:


{
  "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"
}

Struttura dello schema, versione 1.2

In un pacchetto restituito, i campi possono essere presenti in qualsiasi ordine. Nella descrizione che segue, sono organizzati in gruppi correlati.

Autenticazione di base

Oltre alla richiesta webhook inviata da Cloud Monitoring, l'autenticazione di base utilizza la specifica HTTP per il nome utente e la password. Cloud Monitoring richiede che il server restituisca una risposta 401 con l'intestazione WWW-Authenticate corretta. Per ulteriori informazioni sull'autenticazione di base, consulta quanto segue:

Autenticazione token

L'autenticazione dei token richiede un parametro di stringa di query nell'URL dell'endpoint e una chiave che il server si aspetta sia segreta tra sé e il monitoraggio. Di seguito è riportato un URL di esempio che include un token:

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Se il monitoraggio pubblica un incidente nell'URL dell'endpoint, il tuo server può convalidare il token allegato. Questo metodo di autenticazione è più efficace se utilizzato con SSL/TLS per criptare la richiesta HTTP e impedire agli utenti malintenzionati di apprendere il token.

Per un server di esempio in Python, consulta questo server di esempio.

Norme sul ritiro

Lo schema del payload è soggetto alle norme sul ritiro di Google Cloud descritte nella Sezione 1.4(d) dei Termini di servizio della piattaforma Google Cloud. Tieni presente che lo schema non controlla i formati dei valori di campo generati e che questi formati possono cambiare senza preavviso. Ad esempio, incident.summary, incident.documentation.content e incident.url devono includere i dati relativi ai rispettivi campi, ma lo schema non ha vincoli per garantire l'analisi accurata di questi campi. Puoi utilizzare il valore nel suo complesso e presumere che rispetti le norme relative al ritiro, ma non fare affidamento sull'analisi dei campi generati.

Pub/Sub

Questa sezione descrive come configurare i canali di notifica Pub/Sub. Per la ridondanza, ti consigliamo di creare più canali di notifica. Ti consigliamo di accoppiare Pub/Sub con l'app mobile della console Google Cloud, PagerDuty, Webhook o Slack, perché Pub/Sub utilizza un meccanismo di invio diverso.

Per configurare un canale di notifica Pub/Sub:

Abilita le API richieste e crea un argomento
Configurare il canale di notifica per un argomento
Autorizzare un account di servizio
Impostare il canale di notifica in un criterio di avviso

Per comprendere lo schema dei dati, consulta Esempio di schema.

Per ricevere le notifiche di avviso, devi anche creare uno dei seguenti abbonamenti: pull, push o BigQuery.

Se l'abbonamento si trova in un progetto diverso dall'argomento, crea un account di servizio nel progetto dell'abbonato e concedigli il ruolo di roles/pubsub.subscriber.

Prima di iniziare

Quando aggiungi il primo canale di notifica Pub/Sub a un progetto Google Cloud, Cloud Monitoring crea un account di servizio per il progetto. Inoltre, concede all'account di servizio il ruolo di Identity and Access Management Agente servizio di notifica monitoraggio. Questo account di servizio consente a Monitoring di inviare notifiche ai canali di notifica basati su Pub/Sub di questo progetto.

Il service account ha il seguente formato:

service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

Il nome dell'account di servizio di notifica include un numero univoco del progetto Google Cloud. Puoi trovare il nome, l'ID e il numero del progetto nella dashboard del progetto nella console Google Cloud oppure recuperarli con il seguente comando:

gcloud projects describe PROJECT_ID --format="value(project_number)"

Puoi visualizzare e modificare l'account di servizio utilizzando la console Google Cloud o Google Cloud CLI.

Abilita le API richieste e crea un argomento

Nel progetto Google Cloud in cui prevedi di creare il canale di notifica e l'argomento Pub/Sub:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

Creare un argomento Pub/Sub. Per informazioni su come creare un argomento, consulta Creare un argomento. Ad esempio, per creare un argomento denominato notificationTopic utilizzando Google Cloud CLI, esegui il seguente comando:
```
gcloud pubsub topics create notificationTopic
```

Successivamente, configura i canali di notifica Pub/Sub.

Configurare le notifiche per un argomento

Per creare un canale di notifica Pub/Sub, puoi utilizzare l'API Monitoring, Google Cloud CLI o la console Google Cloud. Dopo aver creato il canale di notifica, autorizza l'account di servizio di notifica a pubblicare ogni argomento che utilizzi come canale di notifica.

Per informazioni sull'utilizzo dell'API Monitoring o di Google Cloud CLI per creare il canale di notifica, consulta Creare canali.

Per utilizzare la console Google Cloud per creare il canale di notifica, svolgi i seguenti passaggi:

Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Seleziona il progetto Google Cloud che contiene l'argomento Pub/Sub che hai creato.
Fai clic su Modifica canali di notifica.
Nella sezione Pub/Sub, fai clic su Aggiungi nuovo.

La finestra di dialogo Canale Pub/Sub creato mostra il nome dell'account di servizio creato da Monitoring.
Autorizza l'account di servizio. Il tuo account di servizio può pubblicare tutti gli argomenti o argomenti specifici:
- Per pubblicare tutti gli argomenti, seleziona Gestisci ruoli e aggiungi il ruolo Publisher Pub/Sub.
  
  Dopo aver completato questi passaggi per configurare il canale di notifica, salta la sezione successiva, intitolata Autorizza l'account di servizio, e vai a Impostare il canale di notifica in un criterio di avviso.
- Per pubblicare argomenti specifici, vai al passaggio successivo e autorizza l'account di servizio a pubblicare argomenti specifici dopo aver completato la configurazione del canale di notifica. Per le istruzioni su come autorizzare l'account di servizio, consulta Autorizzare l'account di servizio.
Inserisci un nome visualizzato per il canale e il nome dell'argomento Pub/Sub.
(Facoltativo) Per verificare che il canale sia configurato correttamente, fai clic su Invia notifica di prova.
Seleziona Aggiungi canale.

Successivamente, autorizza l'account di servizio.

Autorizza account di servizio

L'autorizzazione consente all'account di servizio delle notifiche di pubblicare ogni argomento Pub/Sub che utilizzi come canale di notifica. Questa sezione descrive come eseguire le seguenti operazioni:

Autorizza un account di servizio per un argomento specifico.
Autorizza un account di servizio per tutti gli argomenti.

Autorizzare un account di servizio per un argomento specifico

Puoi autorizzare un account di servizio a pubblicare un argomento specifico utilizzando la console Google Cloud e lGoogle Cloud CLI. Questa sezione descrive entrambi gli approcci.

Per autorizzare il tuo account di servizio per un argomento specifico utilizzando la console Google Cloud, segui questi passaggi:

Nella console Google Cloud, vai alla pagina Topic:
Vai ad Argomenti

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Pub/Sub.
Seleziona l'argomento.
Nella scheda Autorizzazioni, seleziona Aggiungi entità.
Nel campo Nuova entità, inserisci il nome dell'account di servizio delle notifiche. L'account di servizio ha la seguente convenzione di denominazione:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Seleziona il ruolo Pub/Sub Publisher e poi Salva.

Per autorizzare il tuo account di servizio per un argomento specifico utilizzando Google Cloud CLI, concedi all'account di servizio il ruolo IAM pubsub.publisher per l'argomento. Ad esempio, il seguente comando configura il ruolo IAM per l'argomento notificationTopic:

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

Una risposta a un'esecuzione corretta del comando add-iam-policy-binding è simile alla seguente:

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1

Per ulteriori informazioni, consulta la pagina di riferimento pubsub topics add-iam-policy-binding.

Autorizzare un account di servizio per tutti gli argomenti

Per autorizzare il tuo account di servizio per tutti gli argomenti:

Nella console Google Cloud, vai alla pagina IAM:
Vai a IAM

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo IAM e amministrazione.
Seleziona Includi concessioni di ruoli fornite da Google come mostrato nella seguente immagine:
Cerca l'account di servizio con il seguente formato:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Ricarica la pagina se il account di servizio non è elencato.
Seleziona Modifica per l'account del servizio di notifiche, seleziona Aggiungi un altro ruolo e poi aggiungi il ruolo Publisher Pub/Sub.

Successivamente, imposta il canale di notifica in un criterio di avviso.

Impostare il canale di notifica in un criterio di avviso

Per utilizzare un canale di notifica Pub/Sub in un criterio di avviso, seleziona Pub/Sub come tipo di canale, quindi seleziona l'argomento.

Esempio di schema

Per visualizzare un pacchetto JSON di esempio e lo schema, espandi le seguenti sezioni.

Esempi di JSON

Di seguito è riportato un esempio di questo tipo di pacchetto:


{
  "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"
}

Struttura dello schema, versione 1.2

In un pacchetto restituito, i campi possono essere presenti in qualsiasi ordine. Nella descrizione che segue, sono organizzati in gruppi correlati.

Norme sul ritiro

Google Chat

L'app Google Cloud Monitoring consente ai tuoi spazi di Google Chat di ricevere notifiche.

Prima di iniziare

Se fai parte di un'organizzazione, per installare l'app Google Cloud Monitoring devi disporre dell'accesso all'app. Se non disponi dell'accesso, richiedi a un amministratore di Google Workspace di svolgere i seguenti passaggi:

Installa l'app Google Cloud Monitoring

Devi utilizzare la procedura riportata di seguito per installare l'app Google Cloud Monitoring. L'installazione dalla scheda del Google Workspace Marketplace non è supportata.

Per installare l'app e configurare uno spazio come canale di notifica:

In Google Chat, apri o crea lo spazio in cui vuoi ricevere le notifiche.
Installa l'app Google Cloud Monitoring:
1. Seleziona il nome dello spazio, quindi App e integrazioni.
2. Se l'app Google Cloud Monitoring non viene visualizzata nell'elenco App, torna al tuo spazio, inserisci @Google Cloud Monitoring e poi premi Invio.
3. Fai clic su Aggiungi allo spazio.
Copia l'ID spazio di Chat negli appunti.

Se hai installato l'app Google Cloud Monitoring, l'ID dello spazio di Chat è incluso nella conferma dell'installazione. In caso contrario, puoi trovare l'ID spazio chat come la serie di numeri e lettere che segue space/ alla fine dell'URL dello spazio chat.
Apri una nuova scheda del browser e configura il canale di notifica:
1. Nella console Google Cloud, vai alla pagina Avvisi:
  Vai ad Avvisi
  
  Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
2. Fai clic su Modifica canali di notifica.
3. Vai alla sezione Google Chat e fai clic su Aggiungi nuovo.
4. Inserisci l'ID spazio di Chat nel campo ID spazio di Chat e poi fai clic su Salva.

Creare un canale on demand

Quando aggiungi un canale di notifica a un criterio di avviso, devi selezionare un canale da un elenco. Per aggiornare l'elenco di opzioni quando crei un criterio di avviso, segui questa procedura:

Nella finestra di dialogo della notifica, fai clic su Gestisci canali di notifica. La finestra Canali di notifica si apre in una nuova scheda del browser.
Per aggiungere un nuovo canale di notifica, individua il tipo di canale, fai clic su Aggiungi nuovo e segui le istruzioni specifiche per il canale riportate nella tabella precedente.
Torna alla scheda originale e nella finestra di dialogo della notifica, fai clic su Aggiorna.
Seleziona il canale di notifica dall'elenco aggiornato.

Ricevere notifiche su un canale non supportato

Se il tuo canale di notifica preferito non è supportato, ti consigliamo di creare una pipeline che si basi sull'invio delle notifiche a Pub/Sub. Per un esempio di Python che utilizza Flask, consulta Creare notifiche personalizzate con Cloud Monitoring e Cloud Run. Per altri esempi, consulta il repository Git cloud-alerting-notification-forwarding.

Testare un canale di notifica

Cloud Monitoring non supporta un'opzione di test per i canali di notifica. Tuttavia, puoi verificare che un canale di notifica sia configurato correttamente creando un criterio di avviso e configurando la condizione da soddisfare.

Per testare manualmente i canali di notifica, puoi creare un criterio di avviso che monitori l'utilizzo della CPU di una delle tue istanze di macchine virtuali (VM):

(Facoltativo) Se non hai ancora una VM nel tuo progetto Google Cloud o vuoi utilizzare una VM diversa per i test, crea una VM:
1. Nella console Google Cloud, vai alla pagina Istanze VM:
  Vai a Istanze VM
  
  Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Compute Engine.
2. Seleziona Crea istanza e configura la VM. Per ulteriori informazioni sulla creazione di VM, consulta Creare un'istanza VM da un'immagine pubblica.
Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Seleziona Crea criterio.
Utilizza il menu Seleziona una metrica per selezionare la metrica Utilizzo della CPU per un'istanza VM.
Fai clic su Aggiungi filtro e aggiungi un filtro per la VM.
Aggiorna i campi Configura trigger come segue:
1. Seleziona Sotto la soglia per il campo Posizione soglia.
2. Seleziona un valore maggiore dell'utilizzo della CPU per l'istanza. Ad esempio, se il grafico indica che l'utilizzo della CPU è pari al 5% circa, imposta la soglia sul 10%.
  
  Queste impostazioni configurano la condizione da soddisfare quando l'utilizzo della CPU di un'istanza VM è inferiore alla soglia specificata. Poiché hai selezionato una soglia maggiore dell'utilizzo della CPU della tua istanza VM, la condizione del criterio di avviso è soddisfatta.
Aggiungi i canali di notifica al criterio.
Espandi Durata chiusura automatica incidenti e seleziona 30 min.
Inserisci un nome per il criterio e fai clic su Crea criterio.
Una volta soddisfatta la condizione, verifica di aver ricevuto una notifica su ogni canale di notifica.
Elimina il criterio di avviso. L'incidente viene chiuso automaticamente al termine della durata della chiusura automatica.
Se hai creato un'istanza VM per questo test, eliminala.

Se non ricevi le notifiche previste, puoi eseguire una ricerca in Esplora log per trovare le voci dei log con informazioni sulle notifiche mancanti. Per ulteriori informazioni, consulta la sezione Le notifiche non vengono ricevute.

Modificare ed eliminare i canali di notifica

Per modificare o eliminare un canale di notifica utilizzando la console Google Cloud, segui questi passaggi:

Nella console Google Cloud, vai alla pagina Avvisi:
Vai ad Avvisi

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Fai clic su Modifica canali di notifica.

La dashboard Canali di notifica contiene una sezione per ogni tipo di canale di notifica. Ogni sezione elenca tutte le configurazioni per quel tipo:
- Per modificare una voce, fai clic su Modifica. Fai clic su Salva al termine delle modifiche.
- Per eliminare una voce, fai clic su Elimina. Fai clic su Elimina nella finestra di dialogo di conferma.

Visualizzare i log dei canali di notifica

Puoi utilizzare Esplora log per visualizzare gli errori del canale di notifica:

Nella console Google Cloud, vai alla pagina Esplora log:
Vai a Esplora log

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
Inserisci ed esegui la query. Per query specifiche relative agli errori dei canali di notifica, consulta Query di Cloud Monitoring.

Passaggi successivi

Per informazioni sugli incidenti, consulta i seguenti documenti: