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 : Commentaires sur l'utilisation : Pour les messages regroupés ( Pour les messages fractionnés ( Pour dédupliquer plusieurs occurrences du même message, utilisez |
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 Exemple de valeur utilisant des variables dynamiques : Exemple de valeur (nom d'affichage de l'alarme) : |
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 : Exemple de valeur (texte) : |
type |
chaîne Motif d'envoi du message d'avis. Les valeurs valides sont les suivantes : Voir Types de message. Exemple de valeur : |
severity |
chaîne Niveau de gravité le plus élevé des alarmes indiquées. Les valeurs valides sont les suivantes : |
timestampEpochMillis |
long Horodatage de l'évaluation, en millisecondes depuis l'époque. Exemple de valeur : |
timestamp |
chaîne Horodatage de l'évaluation, au format ISO-8601. Exemple de valeur : |
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 : |
Métadonnées d'alarme
Paramètre d'alarme | Description et exemple de valeur |
---|---|
id |
chaîne OCID de l'alarme. Exemple de valeur : |
status |
chaîne État de l'alarme. Les valeurs valides sont les suivantes : |
severity |
chaîne Niveau de gravité de l'alarme. Les valeurs valides sont les suivantes : |
namespace |
chaîne Espace de noms de mesure. Exemple de valeur : |
query |
chaîne Interrogation configurée de l'alarme, ou expression MQL. Exemple de valeur : |
totalMetricsFiring |
entier Nombre de flux de mesure représentés dans le message d'avis. Exemple de valeur : |
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 : |
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 : 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 |
chaîne Type d'avis (groupé ou fractionné). Valeurs valides : |
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.
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 <
.
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 |
|
title |
|
body |
(aucune) |
type |
|
severity |
Voir le paramètre enfant |
timestampEpochMillis |
|
timestamp |
|
alarmMetaData |
Voir les paramètres enfants dans le tableau suivant, Métadonnées d'alarme. |
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 |
|
status |
|
severity |
|
namespace |
|
query |
|
totalMetricsFiring |
|
dimensions |
<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
Valeurs : Contenu du message brut associé :
Dans cet exemple, la première valeur retournée Exemple 2 : Valeur unique de la dimension
Valeur : Contenu du message brut associé :
|
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 |
|
alarmSummary |
|
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 |
|
dimensions |
|
metricValues |
|
alarmUrl |
|
alarmSummary |
|
notificationType |
Omis par défaut |