Description
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 a événement ( voir la page Evé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é. |
Si vous avez plusieurs configurations de WebUI présentes dans votre architecture, n'oubliez pas d'activer le module dans chaque configuration. Exemple :
|
Activation du module
Le module event-manager-reader est un module qui peut être activé seulement sur le module WebUI.
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du module WebUI.
- Pour ce faire, ouvrer le fichier de configuration du module WebUI du Broker à l'emplacement /etc/shinken/module/ma_webui.cfg , et ajouter le nom de votre module "
event-manager-reader".
Exemple: par défaut, nous livrons un module dont le nom est "event-manager-reader":
define module {
[...]
modules Module 1, Module 2, Module 3, event-manager-reader
[...]
} |
Pour prendre en compte le changement de configuration, redémarrer l'Arbiter:
service shinken-arbiter restart |
Configuration
La configuration du module que nous livrons par défaut se trouve dans le fichier /etc/shinken/modules/event_manager_reader.cfg
- Vous trouverez aussi systématiquement 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
# CFG_FORMAT_VERSION 1
#================================================================================
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
# ─── 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 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
} |
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 votre architecture Shinken .
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | event-manager-reader | 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 | --- | event_container | Ne peut ê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 des paramètres communs aux deux méthodes
#======== Database connection ========= # mongodb uri definition for connecting to the mongodb database. You can find the mongodb uri # syntax at https://docs.mongodb.com/manual/reference/connection-string/ uri mongodb://localhost/?safe=true [...] # Which database is used to store sla data database shinken |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | URL | mongodb://localhost/?safe=true | 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 événements |
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 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 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), 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 | 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é pour établir le tunnel. | |
| Entier | Ssecondes | 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 ( 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. |
|
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 | Commentaire | |
|---|---|---|---|---|---|
| Entier | Nombre d'essais | 4 | Nombre d'essais de reconnexion à la base | |
| Entier | Secondes | 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 | Commentaire | |
|---|---|---|---|---|---|
| Entier | Nombre d'essais | 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 played ) ───
# ... : 1 => Enable ( Visual notification is not played ) ───
# ───
# broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 1 |
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 | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | 0 | Permet d'activer/désactiver la notification audio qui sera jouée lorsqu'un nouvel événement apparaît.
|
Paramétrage des notifications visuelles
# ─────────── Visual Notification Parameters ────────────────────────────────────────────────────────── #
# ─── Visual notification on new event ───
# ───
# Default : 0 => Disable ( Visual notification is played ) ───
# ... : 1 => Enable ( Visual notification is not played ) ───
# ───
# broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 1 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | 1 | Permet d'activer/désactiver la notification visuelle qui sera jouée lorsqu'un nouvel événement apparaît.
|
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 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. Utilisez cette option si vous avez un temps de boucle du Broker qui dépasse 30 secondes |