Présentation
Le module SLA peut être accroché à deux endroits : le Broker et la WebUI.
L'accrocher sur la WebUI permet
- De récupérer les valeurs de SLA ( Service Level Agreement ) des éléments supervisés stockées dans la base de données MongoDB définie dans le fichier de configuration ci-dessous.
- De modifier la méthode de lecture de la tendance des SLA ( par exemple, choisir de considérer un statut "Attention" comme une période positive de SLA, ou encore d'exclure les périodes de maintenance dans l'interprétation de la tendance ).
Les deux modules étant complémentaires ( le module SLA sur le Broker étant l'écrivain et celui de la WebUI étant le lecteur ), nous fournissons un seul et unique fichier de configuration commun entre les deux, ceci permettant de garder une cohérence entre l'écriture et la lecture des SLA. Avoir le même fichier, vous évitera de répéter la valeur dans 2 fichiers de configuration dans le cas des paramètres communs. |
Activation du module
Le module sla est un module qui peut être activé sur le module WebUI, mais aussi sur le Broker ( voir Module SLA ).
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du module WebUI correspondant.
- Pour ce faire, ouvrez le fichier de configuration du de la Webui à l'emplacement /etc/shinken/modules/nom_de_la_webui.cfg, et ajouter le nom de votre module "
sla".
Exemple : par défaut, nous livrons un module dont le nom est "sla" :
define module {
[...]
modules Module 1, Module 2, Module 3, sla
[...]
} |
Pour prendre en compte le changement de configuration, redémarrez l'Arbiter:
service shinken-arbiter restart |
Configuration
La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/sla.cfg
- Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/sla/sla-example.cfg
Exemple de fichier de configuration
#================================================================================
# 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 ( days ) ───
# ─── -> 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 ───
# ───
# Default : 03:02 ───
# ─── -> 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) ───
# ───
# 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. ───
# ───
# Default : 0 => Disable ( old SLA will not be recalculated ) ───
# ... : 1 => Enable ( old SLA will be recomputed with current settings ) ───
# ───
# recompute_old_sla 0
# ─── Warning periods ───
# ───
# Default : 0 => Warning counts as DOWN ───
# ... : 1 => Warning counts as UP ───
# ───
# warning_counts_as_ok 0
# ─── Unknown periods ───
# ───
# Default : include => "Unknown" status is counted negatively in the SLA. ───
# ... : 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 ) ───
# ───
# Default : include => Only status is considered. "Missing data" and "Shinken inactive" ───
# status are counted negatively in the SLA. ───
# ... : exclude => No_data are not counted from SLA considered period. ───
# ... : ok => No_data are considered as UP periods. ───
# ───
# no_data_period include
# ─── Downtime periods ───
# ───
# Default : include => Only status is considered. ───
# ... : 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. ───
# ───
# Default : 1 => Enable ( the output will be stored ) ───
# ... : 0 => Disable ( 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. ───
# ───
# Default : Enable => 1 ( the long output will be stored ) ───
# ... : 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. ───
# ───
# Default : empty => ( all output states are stored ) ───
# ... : list of status => ( format is State1, State2, ... ) ───
# ─── -> State ok :OK ───
# ─── -> State warning :WARNING ───
# ─── -> State critical:CRITICAL ───
# ─── -> State unknown :UNKNOWN ───
# ─── 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 ───
# ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ... : 1 => Enable ( enable ssh tunnel ) ───
# ───
# use_ssh_tunnel 0
# ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ───
# ───
# Default : 1 ( number of retry ) ───
# ───
# 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_keyfile ~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 ( number of 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 => X workers ───
# ───
# 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 ( numbers of sla ) ───
# ───
# 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
}
|
Détails des sections composant le fichier de configuration
Identification du module
Il est possible de définir plusieurs instances de module de type "sla" dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | sla | Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir. Doit être unique. | |
| Texte | --- | sla | Ne peut être modifié. |
Suppression des anciennes entrées dans la base d'archives du module SLA ( Inutilisé sur la WebUI )
# ─── Duration in day to keep SLA info. ───
# ─── If value is kept forever the MongoDB database will grow endlessly. ───
# ───
# Default : -1 => kept forever ( days ) ───
# ─── -> 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 ───
# ───
# Default : 03:02 ───
# ─── -> 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) ───
# ───
# time_when_delete_old_SLA 03:02 |
Les entrées dans la base d'archives du module SLA sont supprimées toutes les 24h.
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Entier | jours | -1 | Détermine le nombre de jours à garder dans la base d'archives du module SLA. La valeur minimale acceptée correspond à 7 jours.
| ||
| Texte | heures | 03:02 | Heure de la journée à laquelle les entrées dans la base d'archives du module SLA seront supprimées.
|
Si le Broker ( et donc la WebUI ) 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 ou que le dernier nettoyage date de plus de 24 heures, le nettoyage de la base d'archives du module SLA s'exécutera de nouveau. |
Sauvegarde des SLA brut ( Inutilisé sur la WebUI )
# ─── 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 |
Afin de gérer le flux de données, on enregistre sous un format brut ( raw_sla ) les informations de SLA. Toutes les nuits, ces données sont agrégées dans un nouveau format ( sla_archive ) pour accélérer la lecture et réduire l'espace de stockage nécessaire.
S’il y a une erreur lors du passage entre les deux formats, des données peuvent être irrémédiablement perdues. Afin d'éviter de perdre des données lorsque survient ce type d'erreur, il est possible de conserver les données brutes quelque temps.
Le paramètre "keep_raw_sla_day" permet de choisir combien de temps garder ces données.
Il est possible de diminuer ce paramètre si vous manquez d'espace disque et que les données SLA ne sont pas primordiales pour vous. Inversement si pour vous les données SLA sont critiques il est possible d'augmenter ce nombre ce qui permettra de limiter la perte de données SLA.
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Entier | jours | 7 | Nombre de jours durant lesquels sont gardées les données brutes.
|
La récupération est possible qu'avec l'aide de votre support dédié. |
Option de lecture du taux de SLA
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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. ───
# ───
# Default : 0 => Disable ( old SLA will not be recalculated ) ───
# ... : 1 => Enable ( old SLA will be recomputed with current settings ) ───
# ───
# recompute_old_sla 0
# ─── Warning periods ───
# ───
# Default : 0 => Warning counts as DOWN ───
# ... : 1 => Warning counts as UP ───
# ───
# warning_counts_as_ok 0
# ─── Unknown periods ───
# ───
# Default : include => "Unknown" status is counted negatively in the SLA. ───
# ... : 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 ) ───
# ───
# Default : include => Only status is considered. "Missing data" and "Shinken inactive" ───
# status are counted negatively in the SLA. ───
# ... : exclude => No_data are not counted from SLA considered period. ───
# ... : ok => No_data are considered as UP periods. ───
# ───
# no_data_period include
# ─── Downtime periods ───
# ───
# Default : include => Only status is considered. ───
# ... : 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 |
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Booléen | --- | 0 |
| ||
| Booléen | --- | 0 |
| ||
| String | --- | include |
| ||
| String | --- | include |
| ||
| String | --- | include |
|
Vous trouverez plus de détails sur ces paramètres et sur le fonctionnement des SLA sur cette page : Calcul du taux de SLA |
Option de stockage des Resultats et Resultats longs ( Inutilisé sur la WebUI )
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────── SLA STORED OUTPUT ───────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── This option enables or disables storing sla outputs. ───
# ───
# Default : 1 => Enable ( the output will be stored ) ───
# ... : 0 => Disable ( 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. ───
# ───
# Default : Enable => 1 ( the long output will be stored ) ───
# ... : 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. ───
# ───
# Default : empty => ( all output states are stored ) ───
# ... : list of status => ( format is State1, State2, ... ) ───
# ─── -> State ok :OK ───
# ─── -> State warning :WARNING ───
# ─── -> State critical:CRITICAL ───
# ─── -> State unknown :UNKNOWN ───
# ─── Example : OK, UNKNOWN ───
# ───
# list_of_stored_output_status |
Afin de limiter l'espace pris par la base des SLA il est possible de filtrer les résultats et les résultats longs sauvegardés dans la base.
Il est possible de monitorer l'espace pris par la base grâce au modèle d'hôte : shinken-broker-module-sla-writer
Les résultats et les résultats longs des sondes ne sont que les textes donnés par la commande de vérification.
Exemple : PING CRITICAL - Packet loss = 100%
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Booléen | --- | 1 |
| ||
| Booléen | --- | 1 |
| ||
| Liste | --- | vide | Cette option sera utilisée pour filtrer les résultats et les résultats longs qui seront stockés en fonction du statut de la vérification. Les éléments de la liste sont séparés par une virgule. La valeur vide indique que tous les statuts sont pris en compte. Les statuts possibles sont :
|
Nous conseillons pour limiter l'espace pris par la base des SLA de limiter le nombre de jours sauvegardés via l'option "nb_stored_days" plutôt que de ne pas sauvegarder les résultats et les résultats longs qui sont un véritable atout lors de l'analyse d'incident. |
Accès à la base MongoDB
Cette configuration s'effectue dans le fichier de configuration du module.
Pour se connecter à la base MongoDB utilisée 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é
Configuration des paramètres communs aux deux méthodes
# ───────────────── 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 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | URL | mongodb://localhost/?w=1&fsync=false | Vous pouvez trouver la syntaxe de l'uri de MongoDB à l'adresse https://docs.mongodb.com/manual/reference/connection-string/ | |
| Texte | --- | shinken | Nom de la base de données où sont stockés les données SLA |
Connexion directe au serveur MongoDB
Par défaut, le module se connecte de manière directe à la base MongoDB, définie avec les paramètres communs listés ci-dessus, car le paramètre "use_ssh_tunnel" est à 0.
Connexion par SSH au serveur MongoDB
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 sûr 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é.
# ─── SSH tunnel activation to secure your mongodb connection ───
# ─── That will allow all mongodb to be encrypted & authenticated with SSH ───
# ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ... : 1 => Enable ( enable ssh tunnel ) ───
# ───
# use_ssh_tunnel 0
# ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ───
# ───
# Default : 1 ( number of retry ) ───
# ───
# 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_keyfile ~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 |
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 quelle 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, activez les options suivantes :
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 0 |
| |
| Entier | Nombre d'essais | 1 | Spécifie le nombre supplémentaire de tentatives lors de l'établissement du tunnel SSH si ce dernier n'arrive pas à être établi | |
| Texte | utilisateur unix | shinken | L'utilisateur avec lequel le tunnel sera établi | |
| Texte | chemin de fichier | ~shinken/.ssh/id_rsa | La clé SSH privée présente sur le serveur Shinken qui sera utilisée pour établir le tunnel. | |
| Entier | secondes | 10 | Spécifie le timeout en secondes de la vérification du tunnel SSH avant que la connexion vers MongoDB soit effectuée |
Gestion de l'auto reconnexion avec un cluster MongoDB
# ────────────── 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 ( number of 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. ─── |
Primaire : nom de MongoDB pour désigner un serveur maître, le serveur sur lequel il est possible de faire des requêtes d'écriture dans la base. Élection : processus de MongoDB pour choisir un nouveau membre Primaire si le membre Primaire devient inaccessible. |
Dans le cas de l'utilisation d'un cluster MongoDB, lorsque le membre Primaire devient inaccessible une nouvelle élection est déclenchée 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 égal au paramètre "auto_reconnect_max_try " avec une pause de X secondes entre chaque essai ( 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 MongoDB.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Entier | essais | 4 | Nombre d'essais de reconnexion à la base | |
| Entier | secondes | 3 | Temps entre chaque essai en secondes |
Les valeurs par défauts du fichier laissent 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 ( Inutilisé sur la WebUI )
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────── 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 => X workers ───
# ───
# broker_module_nb_workers 1 |
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 répartir 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 élevée.
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Entier | nombre de worker | 1 | Nombre de workers ( nombre de clone du module ) qui traitent le flux de données pour sauvegarder les données SLA dans la base MongoDB.
|
Ne pas dépasser le nombre de core CPU de la machine : cela serait contre-productif pour les performances. |
Options internes
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────── 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 ( numbers of sla ) ───
# ───
# 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 |
Ces paramètres sont dédiés au fonctionnement interne au module, il est fortement recommandé de ne pas les modifier sans votre support dédié. |
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Entier | secondes | 30 | Temps d'inactivité du Broker avant de considérer que Shinken est inactif.
| ||
| Entier | nombre d'éléments | 10000 | Nombre maximum d'éléments archivés en un seul passage en masse.
| ||
| Décimal | secondes | 0.1 | Temps entre deux lots d'éléments à archiver.
| ||
| Entier | nombre d'archives SLA | 10000 | Nombre maximum d'archive SLA supprimée chaque daily_clean_pause_time. Utilisez cette option si à 03:02 ( heure de nettoyage quotidien ) votre MongoDB est saturé.
| ||
| Entier | secondes | 2 | Délai entre deux nettoyages des données SLA. Utilisez cette option si à 03:02 ( heure de nettoyage quotidien ) votre base MongoDB est saturée.
| ||
| Entier | nombre de données SLA | 1000 | Nombre maximum d'archives SLA migrées et sauvegardées en même temps.
| ||
| Décimal | secondes | 0.1 | Délai entre deux sauvegardes de lots de migration.
|
Erreurs dans le Module
Si le module a une erreur inattendue comme un crash, alors le module s’arrête et n'est pas automatiquement redémarré.
Vous trouverez une erreur FATALE avec la commande shinken-healthcheck.
|
