Documentation Oracle Cloud Infrastructure

Utilisation de variables dynamiques dans les messages d'alarme

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

Reportez-vous également à Création d'une alarme de référence.

Mode d'affichage des variables dynamiques

Remarque

Insérez des variables dynamiques qui respectent la longueur maximale pour tous les cas d'emploi pris en charge. Les variables dynamiques qui dépassent le maximum sont considérées comme non valides. Par exemple, envisagez 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 des champs pris en charge. Par exemple, entrez le corps d'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) s'affiche comme suit : Alarme CRITICAL déclenchée car le seuil a été dépassé en raison de [CpuUtilization[1m].mean() :92] à l'adresse 2023-08-15T19 :51 :00Z

Exemple de variables dynamiques affichées dans un message électronique formaté.

Les variables dynamiques apparaissent dans les notifications contenant 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, la variable n'est pas résolue et apparaît comme codée. 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.

Rechercher des variables dynamiques

Pour rechercher une variable dynamique pour un paramètre, reportez-vous à Variables dynamiques.

    1. Sur la page de liste Définitions d'alarme, sélectionnez l'alarme à utiliser. Si vous avez besoin d'aide pour trouver la page de liste ou l'alarme, reportez-vous à Liste des alarmes.
    2. Accédez à Actions, puis sélectionnez Modifier une alarme.
    3. Sur la page Modifier une alarme, recherchez le champ auquel ajouter des variables dynamiques.
      • Corps de l'alarme (paramètre de message d'alarme body) : rendu en tant que champ dans le corps du message d'alarme.
      • Récapitulatif des alarmes (paramètre de message d'alarme alarmSummary) : rendu en tant que champ dans le corps du message d'alarme.
      • Objet de notification (paramètre de message d'alarme title) : le rendu dépend du type de message. Pour un message électronique formaté, s'affiche en tant que ligne d'objet. Pour un message Slack, affiche le titre. Pour un message SMS, s'affiche dans le cadre du message.
        Remarque

        Insérez des variables dynamiques qui respectent la longueur maximale pour tous les cas d'emploi pris en charge. Les variables dynamiques qui dépassent le maximum sont considérées comme non valides. Par exemple, envisagez 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, reportez-vous à Format de message d'alarme.

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

      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, reportez-vous à 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 afficher 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 d'utiliser des variables dynamiques dans le champ de votre choix :

    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> [...]

    Afin d'obtenir la liste complète des paramètres et des valeurs pour les commandes de l'interface de ligne de commandes, reportez-vous à Référence de ligne de commandes pour la surveillance.

  • Exécutez l'opération UpdateAlarm pour mettre à jour une alarme afin d'utiliser l'option de format de message souhaitée.

    Lors de la définition des détails pour UpdateAlarmDetails, définissez le champ de votre choix (alarmSummary, body ou notificationTitle) sur le texte de votre choix, y compris les variables dynamiques.