Alarmes

Structure

Voici la structure d'une alarme.

{
"_id" :                         // alarm ID, generated by Canopsis
"t" :                           // creation date UNIX timestamp
"d" :                           // entity ID related to the alarm
"v" : {
    "state" : {
        "_t" :                  // current state
        "t" :                   // latest state change date as a UNIX timestamp
        "a" :                   // latest state change author
        "m" :                   // latest state change output
        "val" :                 // current state value
    },
    "status" : {
        "_t" :                  // current status value
        "t" :                   // latest status change date as a UNIX timestamp
        "a" :                   // latest status change author
        "m" :                   // latest status change output
        "val" :                 // current status value
    },
    "steps" : [                 // alarm history
        {
          ...
        }
    ],
    "component" :               // component name
    "connector" :               // connector type
    "connector_name" :          // connector identifier
    "creation_date" :           // alarm creation date as a UNIX timestamp
    "display_name" :            // randomly generated string
    "initial_output" :          // output value on alarm creation
    "output" :                  // current output
    "initial_long_output" :     // long output value on alarm creation
    "long_output" :             // current long output
    "long_output_history" : [   // history of values for the long output
        ...
    ],
    "last_update_date" :        // latest update date as a UNIX timestamp
    "last_event_date" :         // latest event date as a UNIX timestamp
    "tags" : [],
    "total_state_changes" :     // number of times the alarm state changed
    "extra" : {},               // extra datas added with external scripts, e.g `activation_date`
    "infos" : {}                // extra infos added with engine-dynamic-infos
}
}

Complément d'information :

• last_update_date: Correspond à l'horodatage de la dernière modification de l'alarme (changement de criticité, pose d'un acquittement…).
• last_event_date: Correspond à l'horodatage du dernier événement reçu pour cette alarme même si cela n'a pas généré de changement.

Par défaut, la valeur de last_update_date est égale à la valeur de last_event_date.

Pour activer la dissociation des deux variables, il est nécessaire de configurer l'option EnableLastEventDate = true dans le fichier canopsis.toml.

Note

Toute modification d'une de ces valeurs implique de suivre de le Guide de modification du fichier canopsis.toml.

Collection MongoDB

Les alarmes sont stockées dans la collection periodical_alarm du MongoDB de Canopsis.

Elles ne sont pas purgées automatiquement.

Une procédure existe pour procéder manuellement à leur nettoyage.

---

Dernière mise à jour: 2021-09-03