Annota le notifiche con la documentazione definita dall'utente

In questa pagina viene descritto come configurare la documentazione sui criterio di avviso in modo che le notifiche forniscano a chi risponde agli incidenti le risorse e informazioni aggiuntive per la risoluzione degli incidenti.

Struttura della documentazione

La documentazione di un criterio di avviso è composta da un oggetto, contenuti e link. Puoi configurare la documentazione nella console Google Cloud, nella l'API Cloud Monitoring e Google Cloud CLI.

Soggetti

L'oggetto della documentazione compare nell'oggetto del per gli incidenti correlati al criterio di avviso. I destinatari delle notifiche possono gestire e ordinare le notifiche per oggetto.

L'oggetto può contenere un massimo di 255 caratteri. Se non definisci un oggetto della documentazione, Cloud Monitoring determina l'oggetto. Le righe dell'oggetto supportano testo normale e variabili.

Contenuti

I contenuti della documentazione vengono visualizzati nella seguente notifica tipi:

• Email, sotto l'intestazione Documentazione sulle norme
• PagerDuty
• Pub/Sub
• Slack
• Webhook

Ti consigliamo di configurare i tuoi contenuti in modo che chi risponde può visualizzare le misure di correzione e le informazioni sugli incidenti nelle notifiche in relazione al criterio di avviso. Ad esempio, potresti configurare documentazione per includere un riepilogo dell'incidente informazioni sulle risorse pertinenti.

I contenuti della documentazione supportano testo normale, Markdown, variabili e controlli specifici del canale.

Link

Puoi aggiungere link alla documentazione per consentire a chi risponde alle minacce Accesso a risorse come playbook, repository e dashboard di Google Cloud da una notifica.

"links" [
  {
    "displayName": "Playbook",
    "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
  }
]

### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}

Markdown nei contenuti della documentazione

Puoi utilizzare Markdown per formattare i contenuti della documentazione. I contenuti della documentazione supportano il seguente sottoinsieme di tagging Markdown:

• Intestazioni, indicate da un carattere hash iniziale.
• Elenchi non ordinati, indicati da caratteri iniziali più, meno o asterischi.
• Elenchi ordinati, indicati da un numero iniziale seguito da un punto.
• Testo in corsivo, indicato da singoli trattini bassi o asterischi intorno a una frase.
• Testo in grassetto, indicato da doppi trattini bassi o asterischi intorno a una frase.
• Link, indicati dalla sintassi [link text](url). Tuttavia, ti consigliamo di utilizzare Link per configurare i link per i tuoi contenuti.

Per ulteriori informazioni su questo tagging, consulta qualsiasi riferimento Markdown, ad esempio, Guida al markup.

Variabili nella documentazione

Per personalizzare il testo della documentazione, puoi utilizzare le variabili nel formato ${varname}. Quando la documentazione viene inviata con una notifica, la stringa ${varname} viene sostituita con un valore tratto dalla risorsa Google Cloud corrispondente, come descritto nella tabella seguente.

¹ Ad esempio, ${resource.label.zone} viene sostituito con il valore dell'etichetta zone. I valori di queste variabili sono soggetti raggruppamento; consulta i valori di null per ulteriori informazioni.
² Per recuperare il valore dell'etichetta project_id su un risorsa monitorata nel criterio di avviso, utilizza ${resource.project}.
³ Non puoi accedere alle etichette dei metadati delle risorse definite dall'utente tramite utilizzando resource.label.KEY. Usa metadata.user_label.KEY .

Note sull'utilizzo

• Sono supportate solo le variabili nella tabella. Non puoi combinarli in espressioni più complesse, come ${varname1 + varname2}.
• Per includere la stringa letterale ${ nella documentazione, esegui il comando di escape in $ con un secondo simbolo $ e $${ viene visualizzato come ${ documentazione.
• Queste variabili vengono sostituite con i rispettivi valori solo nelle notifiche inviate tramite i canali di notifica. Nella console Google Cloud, quando viene mostrata la documentazione, vedi le variabili, non i valori. Esempi nella console includono le descrizioni degli incidenti e l'anteprima quando crei un criterio di avviso.
• Assicurati che le impostazioni di aggregazione della condizione non eliminino dell'etichetta. Se l'etichetta viene eliminata, viene restituito il valore dell'etichetta nella la notifica è null. Per ulteriori informazioni, consulta La variabile per un'etichetta di metrica è nullo.

null valori

Valori per le variabili metric.*, resource.* e metadata.* derivano da serie temporali. Se non sono presenti valori, questi possono essere null dalla query della serie temporale.

• Le variabili resource.label.KEY e metric.label.KEY possono avere null valori se il criterio di avviso utilizza l'aggregazione tra serie (riduzione), ad esempio calcolando la SOMMA su ciascuno dei a serie temporali corrispondenti a un filtro. Quando usi l'aggregazione in più serie, tutte le etichette non utilizzate nel raggruppamento vengono eliminate e di conseguenza vengono visualizzate come null quando la variabile viene sostituita con il relativo valore. Tutte le etichette vengono conservati in assenza di aggregazioni tra serie. Per ulteriori informazioni, consulta La variabile per un'etichetta di metrica è nullo.

• I valori delle variabili metadata.* sono disponibili solo se le etichette sono incluse esplicitamente in un filtro o raggruppamento di una condizione per l'aggregazione in più serie. Vale a dire che devi fare riferimento all'etichetta dei metadati filtra o raggruppa per avere un valore per il modello.

Risoluzione variabile

Le variabili nei modelli di documentazione vengono risolte solo nelle notifiche inviato tramite i seguenti canali di notifica:

• Email
• Google Chat
• Slack
• Pub/Sub, schema JSON versione 1.2
• Webhook, schema JSON versione 1.2
• PagerDuty, schema JSON versione 1.2

Controlli del canale

Il testo nel campo della documentazione può includere anche caratteri speciali utilizzati dal canale di notifica stesso per controllare la formattazione e le notifiche.

Ad esempio, Slack utilizza @ per le menzioni. Puoi utilizzare @ per collegare a uno specifico ID utente. Le menzioni non possono includere nomi. Supponi di includere una stringa come questa nel campo della documentazione:

<@backendoncall> Incident created based on policy ${policy.display_name}

Quando il campo della documentazione viene ricevuto dal canale Slack pertinente nell'ambito della notifica, la stringa precedente fa sì che Slack invii un messaggio aggiuntivo allo User-ID backendoncall. Il messaggio inviato da Slack all'utente potrebbero contenere informazioni pertinenti tratte dalla notifica; ad esempio "Incidente creato in base a una frequenza di modifica della CPU elevata per il criterio".

Queste opzioni aggiuntive sono specifiche per i canali: per ulteriori informazioni su ciò che potrebbe essere disponibile, consulta la documentazione fornita dal canale di terze parti.

Esempio

L'esempio seguente mostra le versioni della console Google Cloud e dell'API Cloud Monitoring documentazione del modello per un criterio di avviso relativo all'utilizzo della CPU. In questi esempi viene utilizzato un indirizzo email per il tipo di canale di notifica. I modelli di documentazione includono diverse variabili per riepilogare l'incidente e fare riferimento al criterio di avviso e alla condizione delle risorse REST.

  "documentation": {
    "content": "### CPU utilization exceeded\n\n### Summary\n\nThe ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} in the project ${resource.project} has exceeded 5% for over 60 seconds.\n\n#### Additional resource information\n\nCondition resource name: ${condition.name}  \nAlerting policy resource name: ${policy.name}",
    "mimeType": "text/markdown",
    "subject": "Alert: ${metric.display_name} exceeded",
    "links": [
      {
        "displayName": "Playbook",
        "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
      },
      {
        "displayName": "Repository with debug scripts",
        "url": "https://altostrat.com"
      },
      {
        "displayName": "Google Cloud dashboard",
        "url": "https://example.com"
      }
    ]
  }

### CPU utilization exceeded

#### Summary

The ${metric.display_name} of the ${resource.type}
${resource.label.instance_id} in the project ${resource.project} has
exceeded 5% for over 60 seconds.

#### Additional resource information

Condition resource name: ${condition.name}  
Alerting policy resource name: ${policy.name}  

#### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}  
Repository with debug scripts: https://altostrat.com  
${resource.type} dashboard: https://example.com