Annoter les notifications avec une documentation définie par l'utilisateur

Cette page explique comment configurer la documentation de votre règle d'alerte afin que les notifications fournissent aux personnes chargées de répondre aux incidents des ressources et des informations supplémentaires pour résoudre les incidents.

Structure de la documentation

La documentation d'une règle d'alerte se compose d'un sujet, d'un contenu et de liens. Vous pouvez configurer la documentation dans la console Google Cloud , l'API Cloud Monitoring et Google Cloud CLI.

Sujets

Le sujet de votre documentation s'affiche dans l'objet des notifications d'incidents liés à votre règle d'alerte. Les destinataires des notifications peuvent les gérer et les trier par sujet.

Les lignes d'objet sont limitées à 255 caractères. Si vous ne définissez pas d'objet dans votre documentation, Cloud Monitoring détermine la ligne d'objet. Les lignes d'objet acceptent le texte brut et les variables.

Contenu

Le contenu de votre documentation apparaît dans les types de notifications suivants :

• E-mail, dans la section Documentation sur les règles
• PagerDuty
• Pub/Sub
• Slack
• Webhooks

Nous vous recommandons de configurer votre contenu de sorte que les personnes chargées de répondre aux incidents puissent consulter les étapes de correction et les informations sur les incidents dans les notifications liées à votre règle d'alerte. Par exemple, vous pouvez configurer la documentation pour inclure un récapitulatif de l'incident et des informations sur les ressources pertinentes.

Le contenu de la documentation est compatible avec les éléments suivants :

• Texte brut
• Variables
• Paramètres spécifiques à une chaîne

• Remise

Liens

Vous pouvez ajouter des liens vers votre documentation afin que les personnes chargées de répondre aux incidents puissent accéder à des ressources telles que des playbooks, des dépôts et des tableaux de bord Google Cloud à partir d'une notification.

L'API Cloud Monitoring vous permet de définir un objet contenant les liens les plus pertinents pour les personnes chargées de répondre. Bien que la console Google Cloud ne comporte pas de champ spécifique pour les liens, vous pouvez ajouter une section pour les liens dans le corps de votre documentation.

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

### Troubleshooting and Debug References

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

Markdown dans le contenu de la documentation

Vous pouvez utiliser le format Markdown pour mettre en forme le contenu de votre documentation. Le contenu de la documentation accepte le sous-ensemble suivant de tags Markdown :

• En-têtes, indiqués par des caractères de hachage initiaux.
• Listes à puces, indiquées par les caractères initiaux plus, moins ou astérisque.
• Listes numérotées, indiquées par un numéro initial suivi d'un point.
• Texte en italique, indiqué par des traits de soulignement ou des astérisques simples autour d'une expression.
• Texte en gras, indiqué par des traits de soulignement ou des astérisques doubles autour d'une expression.
• Liens, indiqués par la syntaxe [link text](url). Pour ajouter des liens à votre notification, nous vous recommandons d'utiliser l'API Cloud Monitoring et de configurer l'objet Link.

Pour plus d'informations sur l'ajout de tags, consultez la documentation de référence sur Markdown, par exemple le guide Markdown.

Variables dans la documentation

Pour personnaliser le texte de votre documentation, vous pouvez utiliser des variables ayant la forme ${varname}. Lorsque la documentation est envoyée avec une notification, la chaîne ${varname} est remplacée par une valeur extraite de la ressource Google Cloud correspondante, comme décrit dans le tableau suivant.

¹ Par exemple, ${resource.label.zone} est remplacé par la valeur du libellé zone. Les valeurs de ces variables peuvent être regroupées. Pour en savoir plus, consultez la section valeurs null.
² Pour récupérer la valeur du libellé project_id sur une ressource surveillée dans la règle d'alerte, utilisez ${resource.project}.
³ Vous ne pouvez pas accéder aux libellés des métadonnées de ressource définies par l'utilisateur à l'aide de la commande resource.label.KEY.. Utilisez la commande metadata.user_label.KEY.

Remarques sur l'utilisation

• Seules les variables de la table sont compatibles. Vous ne pouvez pas les combiner en expressions plus complexes, comme ${varname1 + varname2}.
• Pour inclure la chaîne littérale ${ dans votre documentation, échappez le symbole $ avec un second symbole $. $${ s'affiche alors sous la forme ${ dans votre documentation.
• Ces variables ne sont remplacées par leurs valeurs que dans les notifications envoyées via les canaux de notification. Dans la console Google Cloud , lorsque la documentation est affichée, vous voyez les variables, pas les valeurs. Les exemples présentés dans la console incluent les descriptions des incidents et l'aperçu de la documentation lors de la création d'une règle d'alerte.
• Vérifiez que les paramètres d'agrégation de la condition n'éliminent pas le libellé. Si le libellé est éliminé, sa valeur dans la notification est null. Pour en savoir plus, consultez La variable d'un libellé de métrique est nulle.

null valeurs

Les valeurs des variables metric.*, resource.* et metadata.* sont dérivées de séries temporelles. Leurs valeurs peuvent être null si aucune valeur n'est renvoyée par la requête de séries temporelles.

• Les variables resource.label.KEY et metric.label.KEY peuvent avoir des valeurs null si votre règle d'alerte utilise l'agrégation interséries (réduction), par exemple pour le calcul de la somme sur chacune des séries temporelles correspondant à un filtre. Lorsque vous utilisez l'agrégation interséries, tous les libellés non utilisés dans le regroupement sont supprimés et, par conséquent, ils sont affichés en tant que null lorsque la variable est remplacée par sa valeur. Tous les libellés sont conservés en l'absence d'agrégation interséries. Pour en savoir plus, consultez La variable d'un libellé de métrique est nulle.

• Les valeurs des variables metadata.* ne sont disponibles que si les libellés sont explicitement inclus dans le filtre ou le regroupement d'une condition utilisée pour l'agrégation interséries. En d'autres termes, pour que le libellé que vous référencez ait une valeur dans le modèle, il faut qu’il figure soit dans le filtre soit dans le regroupement.

Résolution variable

Les variables des modèles de documentation ne sont résolues que dans les notifications envoyées à l'aide des canaux de notification suivants :

• E-mail
• Google Chat
• Slack
• Pub/Sub, version 1.2 du schéma JSON
• Webhooks, version 1.2 du schéma JSON
• PagerDuty, schéma JSON version 1.2

Commandes de chaîne

Le texte du champ de documentation peut également inclure des caractères spéciaux utilisés par le canal de notification lui-même pour contrôler la mise en forme et les notifications.

Par exemple, Slack utilise @ pour les mentions. Vous pouvez utiliser @ pour associer la notification à un ID utilisateur spécifique. Les mentions ne peuvent pas inclure de noms. Supposons que vous incluez une chaîne de ce type dans le champ de documentation :

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

Lorsque le champ de documentation est reçu par le canal Slack pertinent dans le cadre de la notification, la chaîne précédente amène Slack à envoyer un message supplémentaire à l'ID utilisateur backendoncall. Le message envoyé par Slack à l'utilisateur peut contenir des informations pertinentes issues de la notification, par exemple "Incident créé en fonction de la règle "Taux de variation élevé du processeur"".

Ces options supplémentaires sont spécifiques aux canaux. Pour en savoir plus sur les possibilités offertes, consultez la documentation fournie par le fournisseur du canal.

Exemple

L'exemple suivant montre les versions de la console Google Cloud et de l'API Cloud Monitoring de la documentation du modèle pour une règle d'alerte sur l'utilisation du processeur. Ces exemples utilisent un e-mail pour le type de canal de notification. Les modèles de documentation incluent plusieurs variables permettant de résumer l'incident et de référencer les ressources REST de la règle d'alerte et de la condition.

  "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