Annoter les incidents à l'aide d'étiquettes

Ce document explique comment organiser et hiérarchiser vos incidents en leur attribuant des étiquettes définies par l'utilisateur. Ces étiquettes sont configurées dans les règles d'alerte et sont répertoriées au niveau des règles d'alerte et des incidents. Selon votre configuration, les libellés sont également répertoriés dans certaines notifications.

À propos des libellés

Les étiquettes, qui sont des paires clé/valeur, permettent d'associer des informations à une série temporelle, à une règle d'alerte, à un incident ou à une notification. Par exemple, les étiquettes d'une série temporelle peuvent identifier l'instance de machine virtuelle (VM) à partir de laquelle les données ont été collectées. Les étiquettes sont prédéfinies ou définies par l'utilisateur.

Étiquettes personnalisés

Les étiquettes définies par l'utilisateur contiennent des informations que vous spécifiez. Ces libellés peuvent avoir des valeurs statiques ou dynamiques:

Les libellés doivent commencer par une lettre minuscule. Les clés d'étiquette et leurs valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets.

Étiquettes prédéfinis

Les étiquettes prédéfinies sont incluses dans les descripteurs de ressources. Elles doivent être renseignées lors de l'écriture de données de séries temporelles. Ces libellés fournissent des informations sur la métrique collectée ou sur la ressource sur laquelle la métrique est écrite. Par exemple, les étiquettes d'une série temporelle peuvent identifier une machine virtuelle (VM), une zone, un projet Google Cloud et un type d'appareil. Lorsque Monitoring crée un incident basé sur cette série temporelle, il hérite de ces étiquettes.

Afficher les libellés

Vous pouvez afficher les étiquettes d'une règle d'alerte ou d'un incident sur la page des détails d'un incident, la page des détails d'une règle d'alerte et dans certaines notifications.

  • Règles d'alerte: les étiquettes statiques définies par l'utilisateur sont répertoriées dans la section Étiquettes utilisateur. Les libellés dynamiques définis par l'utilisateur et les libellés prédéfinis ne sont pas visibles.
  • Incidents: les étiquettes statiques définies par l'utilisateur sont répertoriées dans la section Étiquettes de stratégie, et les étiquettes dynamiques définies par l'utilisateur dans la section Étiquettes de métriques. Les étiquettes prédéfinies sont répertoriées dans les sections Étiquettes de ressources surveillées et Étiquettes de métriques.
  • Notifications: les libellés prédéfinis et les libellés définis par l'utilisateur sont répertoriés dans les types de notifications suivants:

    • E-mail
    • Google Chat
    • PagerDuty
    • Pub/Sub
    • Webhook

Exemple: Ajouter des étiquettes définies par l'utilisateur avec des valeurs dynamiques

Vous pouvez utiliser MQL pour configurer une étiquette afin que sa valeur change de manière dynamique en fonction des données de séries temporelles. Par exemple, vous souhaitez que vos incidents aient une étiquette criticality dont la valeur change en fonction de la valeur de la métrique d'utilisation du processeur surveillée:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| group_by sliding(5m), [value_utilization_mean: mean(value.utilization)]
| map
    add[
      criticality:
        if(val() >= 90 '%', 'CRITICAL',
          if(val() >= 80 '%', 'WARNING',
            if(val() >= 70 '%', 'INFO', 'GOOD')))
    ]
| condition val() >= 70 '%'

La figure suivante montre comment les règles d'alerte qui utilisent des requêtes MQL traitent les données de séries temporelles qu'elles surveillent:

Illustration de la façon dont les règles d'alerte traitent leurs séries temporelles surveillées.

Le gestionnaire de règles traite les données d'utilisation du processeur et génère une série temporelle qui indique quand la condition est remplie. Dans l'exemple précédent, la condition est remplie lorsque l'utilisation du processeur est d'au moins 70%. Pour chaque série temporelle d'entrée, le gestionnaire de règles peut générer l'une des quatre séries temporelles suivantes:

Nom de la série temporelle de sortie Condition remplie Description
"BON" Non Cette série temporelle possède les mêmes étiquettes que la série temporelle d'entrée. Il n'a pas d'étiquette de gravité.
"CRITIQUE" Oui L'utilisation du processeur est d'au moins 90%. La série temporelle de sortie possède les mêmes étiquettes que la série temporelle "BON" et une étiquette de gravité associée à la valeur "CRITICAL".
"AVERTISSEMENT" Oui L'utilisation du processeur est comprise entre 80% et 90%. La série temporelle de sortie possède les mêmes étiquettes que la série temporelle "GOOD" (BON), ainsi qu'une étiquette de gravité associée à la valeur "WARNING" (AVERTISSEMENT).
"INFO" Oui L'utilisation du processeur est d'au moins 70 %, mais inférieure à 80%. La série temporelle de sortie possède les mêmes étiquettes que la série temporelle "GOOD" (Bon), ainsi qu'une étiquette de gravité associée à la valeur "INFO".

Les données de séries temporelles générées par le gestionnaire de règles constituent l'entrée du gestionnaire d'incidents, qui détermine à quel moment les incidents sont créés et fermés. Pour déterminer quand fermer un incident, le gestionnaire d'incidents utilise les valeurs des champs duration, evaluationMissingData et autoClose.

Bonnes pratiques

Pour vous assurer qu'au maximum un incident est ouvert à la fois lorsque vous créez des étiquettes dont les valeurs sont définies de manière dynamique, procédez comme suit:

  • Dans l'objet MetricThreshold, remplacez les valeurs par défaut pour les champs suivants:

    • Champ duration: défini sur une valeur non nulle.
    • Champ evaluationMissingData: défini de sorte que les incidents soient fermés lorsque les données cessent d'arriver. Lorsque vous utilisez l'API Cloud Monitoring, définissez ce champ sur EVALUATION_MISSING_DATA_INACTIVE. Lorsque vous utilisez la console Google Cloud, définissez le champ sur "Points de données manquants traités comme des valeurs qui n'enfreignent pas la condition de la règle".
  • Dans l'objet AlertStrategy, définissez le champ autoClose sur sa valeur minimale de 30 minutes. Lorsque vous utilisez l'API Cloud Monitoring, définissez ce champ sur 30m.

Pour en savoir plus, consultez la section Données de métrique partielles.

Flux des incidents

Supposons que les mesures de l'utilisation du processeur soient inférieures à 70% lors de la création de la règle d'alerte. La séquence suivante illustre la façon dont les incidents sont ouverts et fermés:

  1. Étant donné que les mesures d'utilisation du processeur sont inférieures à 70%, le gestionnaire de règles génère la série temporelle "BONNE" et aucun incident n'est ouvert.

  2. Supposons ensuite que l'utilisation du processeur passe à 93%. Le gestionnaire de règles cesse de générer les données de la série temporelle "BON" et commence à en générer pour la série "CRITICAL".

    Le gestionnaire d'incidents voit une nouvelle série temporelle "CRITICAL" qui remplit la condition, puis ouvre un incident. Cette notification inclut une étiquette de gravité associée à la valeur CRITICAL.

  3. Supposons que l'utilisation du processeur tombe à 75%. Le gestionnaire de règles cesse de générer la série temporelle "CRITICAL" et commence à générer la série temporelle "INFO".

    Le gestionnaire d'incidents voit une nouvelle série temporelle "INFO" qui remplit la condition, puis ouvre un incident. La notification inclut l'étiquette de gravité avec la valeur INFO.

    Le gestionnaire d'incidents constate qu'aucune donnée n'arrive pour la série temporelle "CRITICAL" et qu'un incident est ouvert pour cette série temporelle. Étant donné que cette règle est configurée pour fermer les incidents lorsque les données cessent d'arriver, le gestionnaire d'incidents ferme l'incident associé à la série temporelle "CRITICAL". Par conséquent, seul l'incident dont l'étiquette de gravité a la valeur INFO reste ouvert.

  4. Enfin, supposons que l'utilisation du processeur tombe à 45%. Cette valeur est inférieure à tous les seuils. Le gestionnaire de règles cesse donc de générer la série temporelle "INFO" et commence à générer la série temporelle "GOOD".

    Le gestionnaire d'incidents constate qu'aucune donnée n'arrive pour la série temporelle "INFO" et qu'un incident est ouvert pour cette série temporelle. Comme la règle utilise les paramètres recommandés, l'incident est clôturé.

Si vous n'utilisez pas la valeur recommandée pour le champ evaluationMissingData, les incidents ouverts ne sont pas fermés immédiatement lorsque les données cessent d'arriver. Il se peut donc que plusieurs incidents ouverts s'affichent pour la même série temporelle d'entrée. Pour en savoir plus, consultez la section Données de métrique partielles.

Étapes suivantes