Documentation sur Oracle Cloud Infrastructure

Format des messages d'alarme

Recherchez les paramètres qui apparaissent dans les messages d'alarme envoyés par le service de surveillance. Vérifiez les descriptions des paramètres et les exemples de valeurs, les variables dynamiques et l'apparence par défaut dans les messages formatés.

Les paramètres sont répertoriés dans l'ordre dans lequel ils apparaissent dans les formats joli JSON et brut des courriels.

Paramètres des messages d'alarme

Les tableaux suivants décrivent les paramètres des messages d'alarme et fournissent des exemples de valeurs.

Alarme

Paramètre d'alarme Description et exemple de valeur
dedupekey

chaîne

Identificateur unique de l'alarme (message groupé) ou du flux de mesure dans l'alarme (message fractionné).

Exemple de valeur : exampleuniqueid

Commentaires sur l'utilisation :

Pour les messages regroupés (notificationType : Group notifications across metric streams), utilisez dedupekey pour regrouper les messages appartenant à la même alarme.

Pour les messages fractionnés (notificationType : Split messages per metric stream), utilisez dedupekey pour regrouper les messages appartenant à la même alarme et au même flux de mesure.

Pour dédupliquer plusieurs occurrences du même message, utilisez dedupekey et timestamp ensemble.
title

chaîne

Titre de l'avis de l'alarme (Objet de l'avis dans l'écran Console pour la création et la mise à jour des alarmes). S'il n'est pas spécifié, le nom d'affichage de l'alarme est utilisé.

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.

Exemple de valeur utilisant des variables dynamiques : {{severity}} alarm triggered at {{timestamp}}

Exemple de valeur (nom d'affichage de l'alarme) : High CPU Utilization
body

chaîne

Corps du message configuré de l'alarme (Corps de l'alarme dans l'écran Console pour la création et la mise à jour des alarmes). Nul si non spécifié.

Exemple de valeur utilisant des variables dynamiques : {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Exemple de valeur (texte) : Follow runbook at http://example.com/runbooks
type

chaîne

Motif d'envoi du message d'avis.

Les valeurs valides sont les suivantes : Voir Types de message.

Exemple de valeur : OK_TO_FIRING
severity

chaîne

Niveau de gravité le plus élevé des alarmes indiquées.

Les valeurs valides sont les suivantes : CRITICAL, ERROR, WARNING et INFO
timestampEpochMillis

long

Horodatage de l'évaluation, en millisecondes depuis l'époque.

Exemple de valeur : 1684337663852
timestamp

chaîne

Horodatage de l'évaluation, au format ISO-8601.

Exemple de valeur : 2023-05-17T15:34:23.852Z
alarmMetaData

tableau d'objets

Liste des alarmes associées au message d'avis.

Par exemple, pour les valeurs, voir les paramètres enfants dans le tableau suivant, Métadonnées d'alarme.
version

entier

Version du format de message d'alarme.

Exemple de valeur : 1.5

Métadonnées d'alarme

Paramètre d'alarme Description et exemple de valeur
id

chaîne

OCID de l'alarme.

Exemple de valeur : ocid1.alarm.oc1..exampleuniqueID
status

chaîne

État de l'alarme.

Les valeurs valides sont les suivantes : OK, FIRING
severity

chaîne

Niveau de gravité de l'alarme.

Les valeurs valides sont les suivantes : CRITICAL, ERROR, WARNING, INFO
namespace

chaîne

Espace de noms de mesure.

Exemple de valeur : oci_computeagent
query

chaîne

Interrogation configurée de l'alarme, ou expression MQL.

Exemple de valeur : CpuUtilization[1m].mean() > 90
totalMetricsFiring

entier

Nombre de flux de mesure représentés dans le message d'avis.

Exemple de valeur : 3
dimensions

tableau d'objets

Liste des paires clé-valeur de dimension qui identifient chaque flux de mesure. La liste est limitée à cent entrées.

Exemple de valeur :

{ "instancePoolId": "Default", "resourceDisplayname": "oke-0", "faultDomain": "FAULT-DOMAIN-1", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-2", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-2", "faultDomain": "FAULT-DOMAIN-3", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-1", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-1", "faultDomain": "FAULT-DOMAIN-2", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-3", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }
metricValues

tableau d'objets

Liste de valeurs de mesure pour les paires clé-valeur de dimension (flux de mesure). La liste est limitée à cent entrées.

Exemple de valeur :

[{"CpuUtilization[1m].mean()":"92"},{"CpuUtilization[1m].mean()":"95"},{"CpuUtilization[1m].mean()":"93"}]
alarmUrl

chaîne

Lien vers la page de détails de l'alarme dans la console.

Exemple de valeur : https://cloud.oracle.com/monitoring/alarms/ocid1.alarm.oc1.iad.exampleuniqueid?region=us-ashburn-1
alarmSummary

chaîne

Sommaire des alarmes configuré de l'alarme (Sommaire des alarmes dans l'écran Console pour la création et la mise à jour des alarmes). S'il n'est pas configuré, un message généré par le système qui résume l'état est utilisé.

Exemple de valeur utilisant des variables dynamiques : {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Le contenu du message généré par le système (utilisé lorsque le sommaire de l'alarme n'est pas configuré) dépend de notificationType :

  • Pour Grouped messages across metric streams :

    Alarm <alarm-name> is in a <alarm-state> state; because <number-of-metric-streams> metrics meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>

    Exemple :

    Alarm High CPU Utilization is in a FIRING state; because 4 metrics meet the trigger rule: CpuUtilization[1m].mean() >90, with a trigger delay of 1 minute

  • Pour Split messages per metric stream :

    Alarm <alarm-name> is in a <alarm-state> state; because the resources with dimensions listed below meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>
notificationType

chaîne

Type d'avis (groupé ou fractionné).

Valeurs valides : Grouped messages across metric streams ou Split messages per metric stream

Variables dynamiques

Les tableaux suivants répertorient les variables dynamiques disponibles pour chaque paramètre.

Utilisez la variable dynamique indiquée pour afficher la valeur d'un paramètre dans les messages d'alarme.

Conseil

L'échappement HTML se produit pour la variable dynamique principale (plus courte). Par exemple, lorsque vous utilisez la variable dynamique principale {{title}} pour la valeur de paramètre title alarm for successRate < 0.99, le caractère < est rendu en tant que &lt;.

Pour désactiver l'échappement HTML, utilisez la variable dynamique secondaire (plus longue). Par exemple, lorsque vous utilisez la variable dynamique secondaire {{{title}}} pour la valeur de paramètre title alarm for successRate < 0.99, le caractère < est conservé.

Alarme

Paramètre d'alarme Variables dynamiques*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (aucune)
type
  • {{type}}
  • {{{type}}}
severity

Voir le paramètre enfant severity dans le tableau suivant, Métadonnées d'alarme.
timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

Voir les paramètres enfants dans le tableau suivant, Métadonnées d'alarme.
version
  • {{version}}
  • {{{version}}}

*La variable dynamique principale (plus courte) effectue un échappement HTML. La variable dynamique secondaire (plus longue) conserve les caractères d'entrée.

Métadonnées d'alarme

Paramètre d'alarme Variables dynamiques*
id
  • {{id}}
  • {{{id}}}
status
  • {{status}}
  • {{{status}}}
severity
  • {{severity}}
  • {{{severity}}}
namespace
  • {{namespace}}
  • {{{namespace}}}
query
  • {{query}}
  • {{{query}}}
totalMetricsFiring
  • {{totalMetricsFiring}}
  • {{{totalMetricsFiring}}}
dimensions
  • {{dimensions.<dimension-name>}}
  • {{{dimensions.<dimension-name>}}}

<dimension-name> est le nom de la dimension.

Le nom de dimension doit être valide pour que la variable dynamique soit affichée dans le message d'alarme.

La variable dynamique affiche la première valeur renvoyée. Autrement dit, si plusieurs valeurs distinctes sont retournées, la première valeur est sélectionnée pour le rendu.

Exemple 1 : Valeurs distinctes multiples de la dimension target

  • {{dimensions.target}}
  • {{{dimensions.target}}}

Valeurs : target1, target2

Contenu du message brut associé :

"target": "target1"
…
"target": "target2"

Dans cet exemple, la première valeur retournée target1 est sélectionnée pour le rendu.

Exemple 2 : Valeur unique de la dimension faultdomain

  • {{dimensions.faultdomain}}
  • {{{dimensions.faultdomain}}}

Valeur : FAULT-DOMAIN-3

Contenu du message brut associé :

"faultdomain":"FAULT-DOMAIN-3"
metricValues
  • {{metricValues}}
  • {{{metricValues}}}

Exemple de valeur :

[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]

Contenu du message brut associé :

metricValues:[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]
alarmUrl
  • {{alarmUrl}}
  • {{{alarmUrl}}}
alarmSummary
  • {{alarmSummary}}
  • {{{alarmSummary}}}
notificationType
  • {{notificationType}}
  • {{{notificationType}}}

*La variable dynamique principale (plus courte) effectue un échappement HTML. La variable dynamique secondaire (plus longue) conserve les caractères d'entrée.

Apparence de message formatée par défaut

Les tableaux suivants présentent l'apparence par défaut de chaque paramètre de message d'alarme dans les messages d'alarme formatés.

Alarme

Paramètre d'alarme Aspect du message formaté par défaut
dedupekey
title
body
type
severity Omis par défaut
timestampEpochMillis Omis par défaut
timestamp
alarmMetaData

Voir les paramètres enfants dans le tableau suivant, Métadonnées d'alarme.
version Omis par défaut

Métadonnées d'alarme

Paramètre d'alarme Aspect du message formaté par défaut
id
status
severity
namespace Omis par défaut
query
totalMetricsFiring
  • Courriel (formaté) : Nombre de mesures dépassant le seuil
  • Slack : Nombre de flux de mesure dépassant le seuil
  • SMS : Omis par défaut
dimensions
metricValues
  • Courriel (formaté) : Valeurs de mesure, triées par dimension
  • Slack : Valeurs de mesure, triées par dimension
  • SMS : Omis par défaut
alarmUrl
alarmSummary
notificationType Omis par défaut