Documentation sur Oracle Cloud Infrastructure

Utilisation de variables dynamiques dans les messages d'alarme

Mettez à jour une alarme dans le service de surveillance pour inclure les valeurs des paramètres de message d'alarme dans les messages.

Voir aussi Création d'une alarme de base.

Affichage des variables dynamiques

Note

Insérez des variables dynamiques qui respectent la longueur maximale pour tous les cas d'utilisation pris en charge. Les variables dynamiques qui dépassent le maximum sont considérées comme non valides. Par exemple, considérez une variable dynamique à utiliser dans title. Un cas d'utilisation pris en charge pour title est une ligne d'objet de courriel d'une longueur maximale de 250 caractères. Dans ce cas, la variable dynamique pour un nom de ressource ({{dimensions.<dimension-name>}}) n'est pas valide car elle comporte 256 caractères et dépasse donc le maximum.

La valeur d'un paramètre de message d'alarme est affichée dans un message d'alarme lorsque vous insérez la variable dynamique associée dans les champs pris en charge. Par exemple, entrez le corps de l'alarme suivant :

{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Dans l'image suivante d'un message d'alarme, le corps de l'alarme (Corps) est affiché comme suit : Alarme CRITICAL déclenchée en raison d'une violation du seuil en raison de [CpuUtilization[1m].mean() :92] à 2023-08-15T19 :51 :00Z

Exemple de variables dynamiques affichées dans un courriel formaté.

Les variables dynamiques apparaissent dans les avis qui contiennent des éléments de corps.

  • Si des données sont disponibles pour une variable dynamique, la variable est résolue et les données apparaissent à sa place. L'exemple de message d'alarme précédent affiche [CpuUtilization[1m].mean():92] à la place de la variable dynamique {{metricValues}}.
  • Si aucune donnée n'est disponible pour une variable dynamique, celle-ci n'est pas résolue et apparaît sous forme de code. Par exemple, si aucune valeur de mesure n'est disponible pour la variable dynamique {{metricValues}}, par exemple lorsque l'alarme est à l'état OK, la variable dynamique {{metricValues}} apparaît dans le message d'alarme.
  • Les messages SMS n'ont pas d'éléments de corps, les variables dynamiques ne sont donc pas résolues.

Recherche de variables dynamiques

Pour rechercher une variable dynamique pour un paramètre, voir Variables dynamiques.

    1. Dans la page de liste Définitions d'alarme, sélectionnez l'alarme avec laquelle vous voulez travailler. Si vous avez besoin d'aide pour trouver la page de liste ou l'alarme, voir Liste des alarmes.
    2. Allez à Actions, puis sélectionnez Modifier l'alarme.
    3. Dans la page Modifier l'alarme, recherchez le champ auquel vous voulez ajouter des variables dynamiques.
      • Corps de l'alarme (paramètre du message d'alarme body) : Rendu en tant que champ dans le corps du message d'alarme.
      • Sommaire de l'alarme (paramètre du message d'alarme alarmSummary) : Rendu en tant que champ dans le corps du message d'alarme.
      • Objet de l'avis (paramètre du message d'alarme title) : Le rendu dépend du type de message. Pour un courriel formaté, il s'affiche comme ligne d'objet. Pour un message Slack, s'affiche en tant que titre. Pour un message SMS, le rendu fait partie du message.
        Note

        Insérez des variables dynamiques qui respectent la longueur maximale pour tous les cas d'utilisation pris en charge. Les variables dynamiques qui dépassent le maximum sont considérées comme non valides. Par exemple, considérez une variable dynamique à utiliser dans title. Un cas d'utilisation pris en charge pour title est une ligne d'objet de courriel d'une longueur maximale de 250 caractères. Dans ce cas, la variable dynamique pour un nom de ressource ({{dimensions.<dimension-name>}}) n'est pas valide car elle comporte 256 caractères et dépasse donc le maximum.

      Pour plus d'informations sur l'apparence par défaut de ces paramètres de message d'alarme dans les messages formatés, voir Format de message d'alarme.

    4. Insérez des variables dynamiques pour les paramètres de message d'alarme voulus.

      Exemple avec des variables dynamiques :

      {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

      Pour rechercher des variables dynamiques pour un paramètre, voir Variables dynamiques.

      Vous pouvez désactiver l'échappement HTML en utilisant la variable dynamique plus longue pour un paramètre d'alarme. Par exemple, pour rendre la valeur du paramètre query dans le message d'alarme avec l'échappement HTML désactivé, entrez la variable dynamique {{{query}}}.

    5. Sélectionnez Enregistrer l'alarme.

  • Utilisez la commande oci monitoring alarm update et les paramètres requis pour mettre à jour une alarme afin qu'elle utilise des variables dynamiques dans le champ souhaité :

    oci monitoring alarm update --alarm-summary <text-including-dynamic-variables> --body <text-including-dynamic-variables> --notification-title <text-including-dynamic-variables> [...]

    Avec sauts de ligne :

    oci monitoring alarm update 
--alarm-summary <text-including-dynamic-variables> 
--body <text-including-dynamic-variables> 
--notification-title <text-including-dynamic-variables> [...]

    Pour la liste complète des paramètres et des valeurs pour les commandes de l'interface de ligne de commande, voir Informations de référence sur la ligne de commande pour le service de surveillance.

  • Exécutez l'opération UpdateAlarm pour mettre à jour une alarme afin qu'elle utilise l'option de format de message voulue.

    Lors de la définition des détails pour UpdateAlarmDetails, réglez le champ souhaité (alarmSummary, body ou notificationTitle) au texte souhaité, y compris les variables dynamiques.