Contexte
Le module de type event-manager-reader est un module qui permet au module WebUI ( l'interface de Visualisation ) du Broker d'afficher le bac ร รฉvรฉnement ( voir la page Vue - Les Événements ).
- Il rรฉcupรจre les รฉvรฉnements en base de donnรฉe des รฉvรฉnements.
- Il doit donc รชtre listรฉ dans la liste des modules, des modules de type WebUI ( voir la page Module WebUI, propriรฉtรฉ "modules" ).
Pour que la fonctionnalitรฉ "bac ร รฉvรฉnement" apparaisse dans l'interface, il faut absolument que ce module soit activรฉ.
S'il y a plusieurs configurations de WebUI prรฉsentes dans l'architecture, n'oubliez pas d'activer le module dans chaque configuration.
Exemple :ย
- Plusieurs WebUI sur le mรชme Broker.
- Une WebUI sur diffรฉrents Brokers qui n'utilise pas la mรชme dรฉfinition.
Ce module fonctionne en paire avec le module : event-manager-writer qui a la charge d'รฉcrire en base les informations ( voir la page Module event-manager-writer ).
Activation du module
Les modules de typeย "event_container"ย sont des modules qui doivent รชtre activรฉs sur un module de type "webui", qu'on appellera leย module parent.
- L'activation du module s'effectue en ajoutant leย nomย du module dans la configuration duย module parent.
- Pour cela, il faut ouvrir le fichier de configuration duย module parentย (ย de typeย "
webui"), et ajouter dans le paramรจtreย modules, le nom du module de typeย"event-manager-reader".
- Pour cela, il faut ouvrir le fichier de configuration duย module parentย (ย de typeย "
- Il est possible de faire plusieurs modules de typeย
"event_container".- Cela permet,ย par exemple, d'avoir des configurations diffรฉrentes en fonction des royaumes.
- Cela permet,ย par exemple, d'avoir des configurations diffรฉrentes en fonction des royaumes.
- S'il y a plusieurs modules de typeย
"ย prรฉsents dans l'architecture, il ne faut pas oublier d'activer le module de typeยwebui""dans la configuration de chacun d'eux.event-manager-reader"ย - Contraintesย :
- Activable uniquement sur un module de typeย
"webui"(ย voir la page Module WebUIย ). - Il ne peut y avoir qu'un seul module de typeย
"event_container"ย sur un module de typeย"webui".
- Activable uniquement sur un module de typeย
Pour prendre en compte le changement de configuration, il faut redรฉmarrer l'Arbiter :
service-shinken-arbiter restart
Exemple d'activation du module nommรฉ "event-manager-reader" sur le module nommรฉ "WebUI" ( configuration livrรฉe par dรฉfaut par Shinken )
L'exemple suivant :
- active le module "
event-manager-reader", - sur le module "
WebUI", dont la configuration est dans le fichier /etc/shinken/module/webui.cfg
define module {
[...]
modules ย ย ย ย ย ย ย ย ย Module 1, Module 2, Module 3, event-manager-reader
ย [...]
}
Puis redรฉmarrage de l'Arbiter
service-shinken-arbiter restart
Crรฉer un nouveau module de type event-manager-reader
Pour pouvoir configurer un module de type "event-manager-reader", il faut faire un nouveau fichier de configuration grรขce au fichier d'exemple fourni par dรฉfaut.
- Pour commencer, il faut choisir le nom du nouveau module
- Pour l'exemple, on l'appelle "
Mon-Module-event-manager-reader" Remplacer dans l'exemple le mot "
Mon-Module-event-manager-reader"par le nom qui a รฉtรฉ choisi.
- Pour l'exemple, on l'appelle "
- Puis il faut crรฉer le fichier de configuration :
Copier le fichier de dรฉfinition du module d'exemple : /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/event_manager_reader/event_manager_reader-example.cfg dans le rรฉpertoire de dรฉfinition des modulesย /etc/shinken/modules/ .
( Exemple : /etc/shinken/modules/Mon-Module-event-manager-reader.cfg )cp /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/event_manager_reader/event_manager_reader-example.cfg /etc/shinken/modules/Mon-Module-event-manager-reader.cfg
โ
- Ensuite, il faut modifier le fichier nouvellement crรฉรฉ pour configurer le nouveau module.
Il faut vรฉrifier que le fichier appartienne ร l'utilisateur shinken et qu'il possรจde le droit d'รฉdition. Si ce n'est pas le cas, il faut effectuer les commandes suivante :
chown -R shinken:shinken /etc/shinken/modules/Mon-Module-event-manager-reader.cfg chmod u+w /etc/shinken/modules/Mon-Module-event-manager-reader.cfg
On change le nom du module enย
"Mon-Module-event-manager-reader"dans le fichier /etc/shinken/modules/Mon-Module-event-manager-reader.cfg... ย ย # โโโ Module name [ Must be unique ] [ MANDATORY ] โโโ # โโโ โโโ module_name ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย Mon-Module-event-manager-reader ...
- Ensuite il faut ajouter le nouveau module dans le module de type "
WebUI" correspondantDans notre exemple, on ajoute le module "
Mon-Module-event-manager-reader"au module "WebUI"ย dรฉfinie dans le fichierย/etc/shinken/module/ma_webui.cfgdefine module { [...] modules ย ย ย Module 1, Module 2, Module 3, Mon-Module-event-manager-reader ย ย [...] }
Puis pour finir il faut redรฉmarrer l'Arbiter pour que le Broker puisse prendre en compte ce nouveau module.
service-shinken-arbiter restart
Configuration
La configuration du module que Shinken livre par dรฉfaut se trouve dans le fichier /etc/shinken/modules/event_manager_reader.cfg.
- un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/event_manager_reader/event_manager_reader-example.cfg.
Exemple de fichier de configuration
#================================================================================
# event manager
#================================================================================
# Modules that can load this module:
# - WebUI (to display events data to the users)
# This module read event from database to show you in the WebUI
#================================================================================
define module {
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ MODULE IDENTITY โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ #
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Module name [ Must be unique ] [ MANDATORY ] โโโ
# โโโ โโโ
module_name event-manager-reader
# โโโ Module type [ Do not edit ] [ MANDATORY ] โโโ
# โโโ โโโ
module_type event_container
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ 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 events data โโโ
# โโโ
# Default : event_container โโโ
# โโโ โโโ
# database event_container
# โโโ username/password to authenticate to MongoDB. โโโ
# โโโ Both parameters must be provided for authentication to function correctly. โโโ
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__database__username
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__database__password
ย ย # โโโ SSH tunnel activation to secure your mongodb connection โโโ
# โโโ That will allow all mongodb to be encrypted & authenticated with SSH โโโ
# โโโ
# ... : Enable => 1 ( enable ssh tunnel ) โโโ
# Default : Disable => 0 ( disable ssh tunnel ) โโโ
# โโโ โโโ
# use_ssh_tunnel 0
# โโโ If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive โโโ
# โโโ
# Default : 1 ( try ) โโโ
# โโโ โโโ
# 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 ( 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. โโโ
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ VISUALISATION UI โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ #
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Specify the max retries when the Visualisation UI can't communicate with the event_manager_reader โโโ
# โโโ during the Excel export. โโโ
# โโโ Increase this parameter when users encounter difficulties when generating the Excel export โโโ
# โโโ of events. This will make the export more tolerant to network loss or database slowness, โโโ
# โโโ or restart of the broker. โโโ
# โโโ The value cannot be 0. โโโ
# โโโ
# Default : 2 ( try ) โโโ
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__events_export__max_retry 2
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ DEFAULT NOTIFICATIONS OPTIONS โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ #
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ The parameters below allow users to change default configuration of notification for Events list โโโ
# โโโโโโโโโโโ Sound Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Sound notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Sound notification is not played ) โโโ
# ... : 1 => Enable ( Sound notification is played ) โโโ
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled 0
# โโโโโโโโโโโ Visual Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Visual notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Visual notification is not played ) โโโ
# ... : 1 => Enable ( Visual notification is played ) โโโ
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 0
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ 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
}
Dรฉtails des sections composant le fichier de configuration
Identification du module
Il est possible de dรฉfinir plusieurs instances de module de type "event-manager-reader" dans l'architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
module_name | Texte | --- | event-manager-reader | Shinken conseille de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple ร maintenir. Doit รชtre unique. |
module_typeย | Texte | --- | event_container | Ne dois pas รชtre modifiรฉ. |
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, deux 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 de l'URI de connexion et de l'authentification par mot de passe
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ 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 events data โโโ
# โโโ
# Default : event_container โโโ
# โโโ โโโ
# database event_container ย
# โโโ username/password to authenticate to MongoDB. โโโ
# โโโ Both parameters must be provided for authentication to function correctly. โโโ
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__database__username
# โโโ โโโ
# broker__module_webui__module_event_manager_reader__database__password
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
uri | Texte | URL | mongodb://localhost/?safe=true | Trouver la syntaxe de l'uri de MongoDB ร l'adresse https://docs.mongodb.com/manual/reference/connection-string/ . |
database | Texte | --- | shinken | Nom de la base de donnรฉes oรน sont stockรฉes les donnรฉes รฉvรฉnements. |
broker__module_webui__module_event_manager_reader__database__username | Texte | --- | Utilisateur pour l'authentification avec mot de passe ร la base MongoDB. Utile uniquement si l'activation par mot de passe a รฉtรฉ activรฉ (ย voir la page MongoDB - activation de l'authentification par mot de passeย ) | |
broker__module_webui__module_event_manager_reader__database__password | Texte | --- | Mot de passe de l'utilisateur utilisรฉ pour l'authentification avec mot de passe ร la base MongoDB. Utile uniquement si l'activation par mot de passe a รฉtรฉ activรฉ (ย voir la page MongoDB - activation de l'authentification par mot de passe ) |
Connexion directe 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, ceci correspond au paramรจtre "use_ssh_tunnel" ร 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 la page Sécurisation des connexions aux bases MongoDB ) mais bien plus complexe ร mettre en place. La mรฉthode de connexion par SSH est ainsi prรฉfรฉrable pour des raisons pratiques et de sรฉcuritรฉ.
Connexion par SSH au serveur MongoDB
ย ย # โโโ SSH tunnel activation to secure your mongodb connection โโโ
# โโโ That will allow all mongodb to be encrypted & authenticated with SSH โโโ
# โโโ
# ... : Enable => 1 ( enable ssh tunnel ) โโโ
# Default : Disable => 0 ( disable ssh tunnel ) โโโ
# โโโ
# use_ssh_tunnel 0
# โโโ If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive โโโ
# โโโ
# Default : 1 ( try ) โโโ
# โโโ
# 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 ), il faut 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 | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
use_ssh_tunnel | Boolรฉen | --- | 0 |
|
use_ssh_retry_failure | Entierย | --- | 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 | Texte | Utilisateur unix | shinken | L'utilisateur avec lequel le tunnel sera รฉtabli. |
ssh_keyfile | Texte | Chemin de fichier | ~shinken/.ssh/id_rsaย | La clรฉ ssh privรฉe prรฉsente sur le serveur Shinken qui sera utilisรฉ pour รฉtablir le tunnel. |
ssh_tunnel_timeout | Entier | Seconde | 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
ย ย # โโโโโโโโโโโโโโ 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.
Dรฉfinitions
- 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.ย
- Election : processus de MongoDB pour choisir un nouveau membre Primaire si le membre Primaire devient inaccessible.
Voir : Haute disponibilitรฉ de la base MongoDB (mise en place d'un cluster)
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ย รฉgaux 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 | Description |
|---|---|---|---|---|
auto_reconnect_max_try | Entier | --- | 4 | Nombre d'essais de reconnexion ร la base. |
auto_reconnect_sleep_between_try | Entierย | Seconde | 3 | Temps entre chaque essai en seconde. |
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.
Configuration pour l'interface de visualisation
ย # โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ VISUALISATION UI โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ #
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Specify the max retries when the Visualisation UI can't communicate with the event_manager_reader โโโ
# โโโ during the Excel export. โโโ
# โโโ Increase this parameter when users encounter difficulties when generating the Excel export โโโ
# โโโ of events. This will make the export more tolerant to network loss or database slowness, โโโ
# โโโ or restart of the broker. โโโ
# โโโ The value cannot be 0. โโโ
# โโโ
# Default : 2 ( try ) โโโ
# โโโ
# broker__module_webui__module_event_manager_reader__events_export__max_retry 2
Le paramรจtre "broker__module_webui__module_event_manager_reader__events_export__max_retry" permet de configurer le nombre maximal de tentatives lorsque l'interface de visualisation ne peut pas communiquer avec le module event_manager_reader pendant l'export des donnรฉes vers Excel.
Cela rendra les exports plus tolรฉrants aux pertes de rรฉseau ou aux lenteurs de la base de donnรฉes, ou aux redรฉmarrages du Broker.
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
broker__module_webui__module_event_manager_reader__events_export__max_retry | Entier | --- | 2 | Nombre d'essais d'appel pour l'export des donnรฉes vers Excel. Ne peut pas valoir 0. |
Options de notifications par dรฉfaut
Il est possible de choisir une notification audio ainsi qu'une notification visuelle lorsqu'il y a un nouvel รฉvรฉnement.
Les valeurs de ces paramรจtres impacteront seulement les valeurs par dรฉfaut de la liste d'รฉvรฉnements.
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ DEFAULT NOTIFICATIONS OPTIONS โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ #
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ The parameters below allow users to change default configuration of notification for Events list โโโ
# โโโโโโโโโโโ Sound Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Sound notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Sound notification is not played ) โโโ
# ... : 1 => Enable ( Sound notification is played ) โโโ
# โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled 0
# โโโโโโโโโโโ Visual Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Visual notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Visual notification is not played ) โโโ
# ... : 1 => Enable ( Visual notification is played ) โโโ
# โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 0
Paramรฉtrage des notifications audio
ย ย # โโโโโโโโโโโ Sound Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Sound notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Sound notification is not played ) โโโ
# ... : 1 => Enable ( Sound notification is played ) โโโ
# โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled 0
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled | Texte | --- | 0 | Permetย d'activer/dรฉsactiver la notification audio qui sera jouรฉe lorsqu'un nouvel รฉvรฉnement apparaรฎt. Valeur possible :
|
Changement du son jouรฉ
Pour changer le son jouรฉ lors des notifications de changements (ย voir la page Changer le son des notifications utilisé par l'Interface de visualisationย )
Paramรฉtrage des notifications visuelles
# โโโโโโโโโโโ Visual Notification Parameters โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ #
# โโโ Visual notification on new event โโโ
# โโโ
# Default : 0 => Disable ( Visual notification is not played ) โโโ
# ... : 1 => Enable ( Visual notification is played ) โโโ
# โโโ
# broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 0
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled | Texte | --- | 0 | Permetย d'activer/dรฉsactiver la notification visuelle qui sera jouรฉe lorsqu'un nouvel รฉvรฉnement apparaรฎt. Valeur possible :
|
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
Ces paramรจtres sont dรฉdiรฉs au fonctionnement interne au module, il est fortement recommandรฉ de ne pas les modifier sans le support dรฉdiรฉ.
| Nom | Type | Unitรฉ | Dรฉfaut | Description |
|---|---|---|---|---|
time_before_shinken_inactive | Entierย | Seconde | 30 | Temps d'inactivitรฉ du Broker avant de considรฉrer que Shinken est inactif. Utiliser cette option si le temps de boucle du Broker dรฉpasse 30 secondes. |