Description
Le module SLA permet de calculer les valeurs de SLA (Service Level Agreement) des éléments supervisés et les stocker dans la base de données Mongodb définie dans le fichier de configuration ci dessous. Il est également possible, via ce fichier, de modifier la méthode de calcul des SLA (par exemple, choisir de considérer un Warning comme une période positive de SLA, ou encore d'exclure les périodes de maintenance dans le calcul).
Afin de ne pas casser la base et vos données de SLA, si le module à une erreur inattendu comme un crash alors le module s’arrête et n'est pas automatiquement redémarré. Vous trouverez une erreur FATAL avec la commande shinken-healthcheck.
Configuration du fichier cfg
Voici le fichier CFG de configuration présent dans : /etc/shinken/modules/sla.cfg
#===============================================================================
# sla
#===============================================================================
# Daemons that can load this module:
# - broker (to save sla information into a mongodb database)
# Modules that can load this module:
# - WebUI (to display sla data to the users)
# This module compute and save SLA values into a mongodb database
#===============================================================================
define module {
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── MODULE IDENTITY ────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Module name [ Must be unique ] [ MANDATORY ] ───
module_name sla
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
module_type sla
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── MODULE OPTIONS ─────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Duration in day to keep SLA info. ───
# ─── If value is kept forever the MongoDB database will grow endlessly. ───
# >>> Default : -1 ( kept forever ) ───
# >>> Recommended : 547 ( corresponds to 18 months ) ───
# nb_stored_days 547
# ─── Time of day when cleanup of SLA is performed ───
# ─── When nb_stored_days is set : daily cleanup is done at requested time ───
# ─── format is HH:MM with ───
# ─── -> HH: are the hour of the day (an integer between 0 and 23) ───
# ─── -> MM: are the minutes (an integer between 0 and 59) ───
# >>> Default : 03:02 ───
# time_when_delete_old_SLA 03:02
# ─── Days to keep raw SLA. ───
# ─── In case of issue, these data will be used to re-perform SLA computation. ───
# ─── The drawback of this feature is that it takes more disk space. ───
# >>> Default : 7 ( days ) ───
# keep_raw_sla_day 7
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── SLA CALCULATION ────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Some status can impact ───
# ─── * positively (counted as OK/UP), ───
# ─── * negatively (counted as CRITICAL/DOWN) ───
# ─── * not impact the SLA ───
# ─── (is not counted, meaning the period of study is reduced by the period that is not counted). ───
# ─── This configuration aims at giving Shinken administrators a way to configure ───
# ─── how the SLA are calculated. ───
# ─── SLA are computed on a daily basis. ───
# ─── SLA of the current day are always recomputed after a configuration change. ───
# ─── SLA from days before are by default not recomputed. ───
# ─── Enable : 1 ( old SLA will be recomputed with current settings ) ───
# >>> Disable : 0 ( old SLA will not be recalculated ) ( Default ) ───
# recompute_old_sla 0
# ─── Warning periods ───
# ─── Warning counts as UP : 1 ───
# >>> Warning counts as DOWN : 0 ( Default ) ───
# warning_counts_as_ok 0
# ─── Unknown periods ───
# >>> include : "Unknown" status is counted negatively in the SLA. ( Default ) ───
# ─── exclude : "Unknown" are not counted from SLA considered period. ───
# ─── ok : "Unknown" are considered as UP periods ───
# unknown_period include
# ─── No_data periods ("Missing data" and "Shinken inactive" status) ───
# >>> include : Only status is considered. "Missing data" and "Shinken inactive" status are ───
# counted negatively in the SLA. ( Default ) ───
# ─── exclude : No_data are not counted from SLA considered period. ───
# ─── ok : No_data are considered as UP periods. ───
# no_data_period include
# ─── Downtime periods ───
# >>> include : Only status is considered. ( Default ) ───
# ─── exclude : Downtimes are not counted from SLA considered period. ───
# ─── ok : Downtimes are considered as UP periods. ───
# ─── critical : Downtimes are considered as DOWN periods. ───
# downtime_period include
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────── SLA STORED OUTPUT ───────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── This option enables or disables storing sla outputs. ───
# >>> Enable : 1 ( the output will be stored ) ( Default ) ───
# ─── Disable : 0 ( the output and long output will not be stored ───
# ( downtime and acknowledge will still be stored ) ) ───
# store_output 1
# ─── This option enables or disables storing sla long outputs. ───
# >>> Enable : 1 ( the long output will be stored ) ( Default ) ───
# ─── Disable : 0 ( the long output will not be stored ───
# ( output, downtime and acknowledge will still be stored ) ) ───
# store_long_output 1
# ─── This option will be used to filter which outputs and long outputs ───
# ─── to store depending on the status of the sla. ───
# ─── format is State1, State2, ... ───
# ─── -> State ok : OK ───
# ─── -> State warning : WARNING ───
# ─── -> State critical : CRITICAL ───
# ─── -> State unknown : UNKNOWN ───
# >>> All states : empty ( all output states are stored ) ( Default ) ───
# ─── Example: OK, UNKNOWN ───
# list_of_stored_output_status
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────── DATABASE CONNECTION ──────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ───────────────── MongoDB parameters ──────────────────────────────────────────────────────────────────
# ─── MongoDB uri definition . You can find the mongodb uri syntax at ───
# ─── https://docs.mongodb.com/manual/reference/connection-string/ ───
# >>> Default : mongodb://localhost/?w=1&fsync=false ───
# uri mongodb://localhost/?w=1&fsync=false
# ─── Which database contains sla data ───
# >>> Default : shinken ───
# database shinken
# ─── SSH tunnel activation to secure your mongodb connection ───
# ─── That will allow all mongodb to be encrypted & authenticated with SSH ───
# ─── Enable : 1 ( enable ssh tunnel ) ───
# >>> Disable : 0 ( disable ssh tunnel ) ( Default ) ───
# use_ssh_tunnel 0
# ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ───
# >>> Enable : 1 ( with ssh tunnel ) ( Default ) ───
# ─── Disable : 0 ( direct connection ) ───
# use_ssh_retry_failure 1
# ─── SSH user to connect to the mongodb server. ───
# >>> Default : shinken ───
# ssh_user shinken
# ─── SSH keyfile to connect to the mongodb server. ───
# >>> Default : ~shinken/.ssh/id_rsa ───
# ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds. ───
# >>> Default : 10 ( seconds ) ───
# ssh_tunnel_timeout 10
# ────────────── AutoReconnect Management ───────────────────────────────────────────────────────────────
# ─── When MongoDB require you to reconnect ( For example, It can occur when a new PRIMARY is elected ───
# ─── in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception. ───
# ─── ───
# ─── How many try to reconnect before module go in error ───
# >>> Default : 4 ( try ) ───
# auto_reconnect_max_try 4
# ─── Time between each try ───
# >>> Default : 3 ( seconds ) ───
# auto_reconnect_sleep_between_try 3
# ─── NOTE: Change these values only if you have a MongoDB cluster and you change the ───
# ─── heartbeatTimeoutSecs of your MongoDB replica set ───
# ─── The value of auto_reconnect_max_try * auto_reconnect_sleep_between_try must be higher than ───
# ─── heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set. ───
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────── WORKERS IN THE BROKER ─────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── This module will use workers in the broker, each worker will manage a shard of all hosts/checks. ───
# ─── This parameter is used by the broker to set the number of workers. ───
# ─── Each worker will use one CPU, which will balance the sla processing load among CPUs. ───
# >>> Default : 1 ( one worker ) ───
# broker_module_nb_workers 1
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────── INTERNAL OPTIONS ────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ───
# ─── Broker idle time before considering that Shinken is inactive. ───
# ─── Use this if you have Broker loop time that exceeds 30 seconds ───
# >>> Default : 30 ( seconds ) ───
# time_before_shinken_inactive 30
# ─── Maximum number of elements archived in one bulk pass. ───
# ─── Use this if at 00:05 (archive time) your MongoDB is saturate ───
# >>> Default : 10 000 ( elements numbers ) ───
# size_chunk_to_archive 10000
# ─── Time between two chunk to archive. ───
# ─── Use this if at 00:05 (archive time) your MongoDB is saturate ───
# >>> Default : 0.1 ( seconds ) ───
# time_between_two_chunks 0.1
# ─── Max number of sla remove each daily_clean_pause_time. ───
# ─── Use if nb_stored_days is not -1. ( Daily clean time is activated ) ───
# ─── Use this if at 03:02 (daily clean time) your MongoDB is saturate. ───
# >>> Default : 10 000 ( sla numbers ) ───
# daily_clean_batch_size 10000
# ─── Delay between 2 sla clean. ───
# ─── Use if nb_stored_days is not -1. ( Daily clean time is activated ) ───
# ─── Use this if at 03:02 (daily clean time) your MongoDB is saturate. ───
# >>> Default : 2 ( seconds ) ───
# daily_clean_pause_time 2
# ─── Max number of sla archive migrate save at same time. ───
# ─── Use this if after an Shinken update your MongoDB is saturate. ───
# >>> Default : 1 000 ( sla ) ───
# broker_module_sla_migration_batch_size 1000
# ─── Delay between 2 migrating batch save. ───
# ─── Use this if after an Shinken update your MongoDB is saturate. ───
# >>> Default : 0.1 ( seconds ) ───
# broker_module_sla_migration_pause_time 0.1
} |
Option du module
Suppression des anciennes entrées dans la base d'archives du module SLA
Les entrées dans la base d'archives du module SLA sont supprimées toutes les 24h.
| Nom du paramètre | Valeur par défaut | Description |
|---|---|---|
nb_stored_days | -1 | Détermine le nombre de jours à garder dans la base d'archives du module SLA. La valeur minimale acceptée correspond à 7 jours. |
time_when_delete_old_SLA | 03:02 | Heure de la journée à laquelle les entrées dans la base d'archives du module SLA seront supprimées. Les données gardées correspondent aux jours définis par la valeur de la propriété nb_stored_days |
Si le Broker est éteint et que la suppression n'est pas faite depuis plus de 24 h, elle se fera automatiquement au démarrage du Broker. |
S'il n'y a aucune trace du dernier nettoyage de la base d'archives du module SLA, le nettoyage s'exécutera. |
Accès à la base MongoDB
Cette configuration s'effectue dans le fichier de configuration du module.
Pour se connecter à la base MongoDB utilisé pour le stockage des données, 2 méthodes sont disponibles:
- Connexion directe: Par défaut, mais non sécurisée.
- Tunnel SSH: Shinken se connecte à la base MongoDB au travers d'un module SSH pour plus de sécurité
Connexion directe au serveur Mongo
Par défaut, le module se connecte de manière directe à la base MongoDB pour y lire et écrire les données.
Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le paramètre "use_ssh_tunnel" est à 0.
Cette méthode de connexion a pour avantage d'être facile à configurer au niveau de Shinken. Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.
La sécurisation de la base MongoDB est bien sur toujours possible (voir Sécurisation des connexions aux bases MongoDB) mais bien plus complexe à mettre en place. La méthode de connexion par SSH est donc préférable pour des raisons pratiques et de sécurité.
Connexion par SSH au serveur Mongo
Le module peut également se connecter par tunnel SSH à la base MongoDB, pour des raisons de sécurité.
En effet, le paramétrage de MongoDB permet de définir sur quel interface réseau ce dernier écoute les requêtes.
En n'autorisant seulement interface réseau avec l'adresse 127.0.0.1, cela évite d'ouvrir la base au monde extérieur.
Dans la configuration de la base MongoDB (/etc/mongod.conf), assurez-vous que le paramètre "bind_ip" est positionné pour n'écouter que sur l'interface locale:
bind_ip=127.0.0.1
Dans cette configuration la base MongoDB écoute que sur l'interface réseau local, pour que le module se connecte, il faut passer par un tunnel SSH. Pour ce faire activer les options suivantes :
| Nom du paramètre | Valeur par défaut | Description |
|---|---|---|
use_ssh_tunnel | 0 |
|
use_ssh_retry_failure | 1 | Spécifie le nombre supplémentaire de tentatives lors de l'établissement du tunnel SSH si ce dernier n'arrive pas à être établi |
ssh_user | shinken | L'utilisateur avec lequel le tunnel sera établit |
ssh_keyfile | ~shinken/.ssh/id_rsa | La clé ssh privée présent sur le serveur Shinken qui sera utilisé pour établir le tunnel. |
| ssh_tunnel_timeout | 10 | Spécifie le timeout en secondes de la vérification du tunnel SSH avant que la connexion vers MongoDB soit effectuée |
Le tunnel SSH va permettre au module de se connecter comme si ses requêtes étaient local à la base MongoDB ( en 127.0.0.1 )
- Connectez-vous avec le user lançant le démon sur le serveur Shinken
- Générez la paire de clés SSH si nécessaire
- Copiez la clé publique sur le serveur mongo
root@serveur_shinken # su - shinkenshinken@serveur_shinken $ ssh-keygenshinken@serveur_shinken $ ssh-copy-id user_distant@serveur_mongo[...]shinken@serveur_shinken $ ssh user_distant@serveur_mongouser_distant@serveur_mongo $
- Cette manipulation est aussi nécessaire dans le cas ou la base MongoDB est sur le même serveur que le module, même si le tunnel est ouvert localement.
Gestion de l'auto reconnexion avec un cluster MongoDB
|
Dans le cas de l'utilisation d'un cluster MongoDB, lorsque le membre Primaire devient inaccessible une nouvelle élection est déclenché ce qui provoque une coupure temporaire de l'accès à la base.
Dans le but de ne pas interrompre le service, le module SLA va se reconnecter automatiquement au cluster MongoDB.
Pour ce faire il va faire un nombre d'essais égale au paramètre "auto_reconnect_max_try " avec une pause de X secondes entre chaque essais (correspondant au paramètre "auto_reconnect_sleep_between_try").
Par défaut pour MongoDB le temps maximum avant qu'un membre Primaire soit considéré comme indisponible et qu'une nouvelle élection ait lieu est de 10 secondes.
Voir : "heartbeatTimeoutSecs" donné par la commande rs.conf(); dans un shell de mongo.
| Nom du paramètre | Valeur par défaut | Description |
|---|---|---|
| 4 | Nombre d'essais de reconnexion à la base |
| 3 | Temps entre chaque essais en seconde |
Les valeurs par défauts du fichier laisse 12 secondes, ce qui est amplement suffisant avec la configuration par défaut de MongoDB.
Il est conseillé de ne pas modifier ces valeurs. |
Utilisation des workers du module SLA
Le paramètre "broker_module_nb_workers" va déterminer combien de fois le module SLA va se cloner pour gérer le flux de donnée à enregistrer afin de repartir cette charge sur plusieurs CPU.
Il est possible de changer ce paramètre si l’utilisation CPU du processus : "NOM DU BROKER [ - Module: sla ][ Worker: 0 ]" est trop élever.
| Nom du paramètre | Valeur par défaut | Description |
|---|---|---|
broker_module_nb_workers | 1 | Nombre de workers ( nombre de clone du module ) qui traite le flux de donnée pour sauvegarder les données SLA dans la base MongoDB |
Ne pas dépassé le nombre de core cpu de la machine : cela serais contre productif pour les performances. |