Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Panel
titleSommaire

Table of Contents
stylenone

Description

Concept

Le module de type event-manager-reader est un module qui permet au module WebUI ( l'interface Interface de visualisation Visualisation ) du broker Broker d'afficher le bac à événementsé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 du module de type WebUI ( cf  voir la page Module WebUI, propriété "modules" ).

Warning

Pour que la fonctionnalité le menu "bac à événement" apparaisse dans l'interface, il faut absolument que ce module soit activé.

Info

Si vous avez plusieurs configurations de du module WebUI présente présentes dans votre architecture, n'oubliez pas d'activer le module "event-manager-reader" dans chaque configuration.

Exemple : 

  • Plusieurs modules WebUI sur le même Broker.
  • Une Un module WebUI différent sur différents Brokers qui n'utilise pas la même définitionconfiguration.

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 il faut ouvrir le fichier de configuration du module WebUI du Broker à l'emplacement /etc/shinken/brokersmodule/nomma_du_brokerwebui.cfg, et ajouter le nom de votre du module "WebUIevent-manager-reader".


Exemple : par défaut, nous livrons est livré un module dont le nom est " event-manager-reader":

Code Block
languagejs
themeConfluence
define module {
    [...]
    modules                   Module 1, Module 2, Module 3, event-manager-reader
    [...]
}


Pour prendre en compte le changement de configuration, redémarrer l'Arbiter:

Code Block
languagetext
themeEmacs
service shinken-arbiter restart

Configuration

La configuration du module que nous livrons livré par défaut se trouve dans le fichier  /etc/shinken/modules/event_manager_reader.cfg

  • Vous trouverez aussi systématiquement un exemple dans Un fichier d'exemple est disponible ici : /etc/shinken-user-example/configuration/daemons/brokers/modules/event_manager_reader/event_manager_reader-example.cfg

Exemple de fichier de configuration

Code Block
title/etc/shinken/modules/event-manager-reader.cfg
languagejs
themeConfluence
# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

##================================================================================
# 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

    # ─── SSHusername/password tunnelto activationauthenticate to secureMongoDB. your mongodb connection                                           ───
    # ─── That will───
 allow all mongodb to# be─── encryptedBoth &parameters authenticatedmust withbe SSHprovided for authentication to function  correctly.                        ───
    #    ───                                                                                                   ───
    #          ...broker__module_webui__module_event_manager_reader__database__username 

    # :─── Enable  => 1 ( enable ssh tunnel )                                                 ───
    #          Default : Disable => 0 ( disable ssh tunnel )                  ───
    # 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                              ───
    #                         ───
    # use_ssh_tunnel                                      0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #            ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )                                                ───
    #           Default : Disable ───
=> 0 ( disable #ssh tunnel )        Default : 1 ( try )                                  ───
    # ───                                   ───
    #                                                            ───
    # use_ssh_tunnel                                      ───0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #                      1

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #        ───
    #           Default : 1 ( try )                                                                         ───
    # ───
           #          Default : shinken                                                                            ───
    # use_ssh_retry_failure                               1

    # ─── SSH user to connect to the mongodb   server.                                                        ───
    #  ssh_user                                             shinken

    # ─── SSH keyfile to connect to the mongodb server.                                           ───
    #      ───
    # Default : shinken                                                                           ───
    # ───                    ───
    #          Default : ~shinken/.ssh/id_rsa                                                               ───
    # ssh_user                                            shinken

    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #  ssh_keyfile                                           ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #        ───
    #           Default : ~shinken/.ssh/id_rsa                                                              ───
    # ───           ───
    #          Default : 10 ( seconds )                                                                     ───
    # ssh_keyfile                                         ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in 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.  #           Default : 10 ( seconds )     ───
     # ───                                                         ───
    # ───                                     ───
    # ─── How many try to reconnect before module go in error                                               ───
    # 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.              ───
    #     ───
    # Default─── : 4 ( try )                                                                          ───
    #                ───
    # ─── How many try to reconnect before module go in error                                               ───
    #                       ───
    # auto_reconnect_max_try                              4

    # ─── Time between each try                                    ───
    #           Default : 4 ( try )                     ───
    #                                                ───
    # ───                                                  ───
    #          Default : 3 ( seconds )                              ───
    # auto_reconnect_max_try                              4

    # ───
 Time between each #try                                                                             ───
    #                      ───
    # 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───
    #           Default : 3 ( seconds )                        ───
    # ───       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.                           ───
    # auto_reconnect_sleep_between_try                    3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the  ───
    # ─── Increase this parameter when users encounter difficulties when generating the Excel export        ───
    # ─── of events. This will make the exportheartbeatTimeoutSecs moreof tolerantyour toMongoDB networkreplica lossset or database slowness,          ───
    # ─── or restart of the broker.                     ───
    # ───       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.         ───
    # ─── The value cannot be 0.      ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    #  ─────────────────────────────────────    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, ───
    #     ───
    # Default─── :or 2restart (of trythe ) broker.                                                                         ───
    # ─── The value cannot be 0.                                                                            ───
    #                 ───
    # broker__module_webui__module_event_manager_reader__events_export__max_retry 2

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    #  ─────────────────────────────────────    INTERNAL OPTIONS    ──────────────────────────────────────  #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT                         ───
    # ─── Broker idle time before considering───
 that Shinken is inactive.#           Default : 2 ( try )                     ───
    # ─── Use this if you have Broker loop time that exceeds 30 seconds                                     ───
    #  ───                                                                                                     ───
    #     broker__module_webui__module_event_manager_reader__events_export__max_retry 2

    # Default┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ :#
 30 ( seconds )#  ─────────────────────────────────────    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                                     ───
    #                ───
    # 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-writer" dans votre architecture Shinken.

  • Chaque instance devra avoir un nom unique.
NomTypeUnitéDéfautCommentaire
Code Block
source_name 
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.

Code Block
module_type 
Texte---event_containerNe 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, 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 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 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é.

Code Block
languagejs
    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────────
 
    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                                          ───
    #           Default : 30 ( seconds )                                                                    ───
    # ───                                                                                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/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.
Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
module_name 
Texte---event-manager-reader

Il est conseillé de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

Doit être unique.

No Format
module_type 
Texte---event_containerNe 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 de l'URI de connexion et de l'authentification par mot de passe
Code Block
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    DATABASE CONNECTION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
               ───
    #                                                                                                       ───
    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────── #

    # Default─── : mongodb://localhost/?w=1&fsync=false       MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ───
 https://docs.mongodb.com/manual/reference/connection-string/     #                                 ───
    #                                                                  ───
    # uri                                ───
    #           Default : mongodb://localhost/?w=1&fsync=false
 
    # ─── Which database contains events data                                   ───
    # ───                       ───
    #                                                                        ───
    # uri                          ───
    #          Default : event_container       mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains events data                                                   ───
    #        ───
    #                                                                                           ───
    # database       ───
    #           Default : event_container                    event_container
NomTypeUnitéDéfautCommentaire Code Block
 
uri
 
TexteURLmongodb://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/

Code Block
 
database
 
Texte---event_container

Nom de la base de données où sont stockés les données événements

Connexion par SSH au serveur MongoDB
Code Block
languagejs
    # ─── SSH tunnel activation to secure your mongodb connection                                ───
    # ───      ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                                          ───
    # database                                            event_container

    # ─── username/password to authenticate to MongoDB.  ───
    #          ...     : Enable  => 1 ( enable ssh tunnel )                       ───
    # ─── Both parameters must be provided for authentication to function correctly.           ───
    #         ───
  Default : Disable# =>─── 0 ( disable ssh tunnel )                                                ───
    #                                         ───
    # broker__module_webui__module_event_manager_reader__database__username 

    # ───                                                   ───
    # use_ssh_tunnel                                      0
 
    # ───
 If the SSH # broker__module_webui__module_event_manager_reader__database__password 
Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
 uri 
TexteURLmongodb://localhost/?safe=true

La page suivante decrit la syntaxe de l'uri de MongoDB : https://docs.mongodb.com/manual/reference/connection-string/.

No Format
 database 
Texte---shinken

Nom de la base de données où sont stockées les données événements.

No Format
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  ).

No Format
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.
C'est la méthode de connexion par défaut lorsque la base est sur la même machine que le démon ( quand l'URL de la base est localhost ).

Si la base est sur une autre machine, il faudra alors se connecter à la base via un tunnel SSH. Cela permet à la base distance de rester en écoute réseau sur l'interface réseau local, ce qui la sécurise des accès extérieurs ( voir la pageSécurisation des connexions aux bases MongoDB ).

Connexion par SSH au serveur MongoDB
Code Block
languagejs
themeConfluence
    # ─── SSH tunnel activation to secure your mongodb connectionconnection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #                                                                                                       ───
    #          Default : 1 ( try )                                                                          ───
    #                                                                                             ───
    # ─── That will allow all ───
mongodb to be encrypted # use_ssh_retry_failure  & authenticated with SSH                             1
 ───
    # ─── SSH user to connect to the mongodb server.                                                                         ───
    #                          ───
    #          ...     : Enable  => 1 ( enable ssh tunnel )                                                 ───
    #          Default : shinkenDisable => 0 ( disable ssh tunnel )                                                ───
    #                 ───
    #                                                                                  ───
    # use_ssh_tunnel                ───
    # ssh_user                 0
 
    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #   shinken
 
    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                             ───
    #          Default : 1 ( try )                                                       ───
    #          Default : ~shinken/.ssh/id_rsa   ───
    #                                                        ───
    #                                           ───
    # use_ssh_retry_failure                               1
 
    # ─── SSH user to connect to the mongodb server.          ───
    # ssh_keyfile                                         ~shinken/.ssh/id_rsa
 ───
    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                         ───
    #          Default : shinken                              ───
    #          Default : 10 ( seconds )                           ───
    #                                      ───
    #                                                             ───
    # ssh_user                                            shinken
 
    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    # ssh_tunnel_timeout                                                  10                                                     ───
    #          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
Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
use_ssh_tunnel
Booléen---0
  • 1 : Connexion par tunnel SSH
  • 0 : Connexion directe
No Format
use_ssh_retry_failure
Entier Nombre d'essais1

Spécifie le nombre supplémentaire de tentatives lors de l'établissement du tunnel SSH si ce dernier n'arrive pas à être établi

No Format
ssh_user
TexteUtilisateur unixshinkenL'utilisateur avec lequel le tunnel sera établi
No Format
ssh_keyfile
TexteChemin de fichier~shinken/.ssh/id_rsa La clé ssh privée présente sur le serveur Shinken qui sera utilisé pour établir le tunnel.
No Format
ssh_tunnel_timeout
EntierSsecondes10Spécifie le timeout en secondes de la vérification du tunnel SSH avant que la connexion vers MongoDB soit effectuée

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 :

NomTypeUnitéDéfautCommentaire
Code Block
use_ssh_tunnel
Booléen---0
  • 1 : Connexion par tunnel SSH
  • 0 : Connexion directe
Code Block
use_ssh_retry_failure
Entier Nombre d'essais1

Spécifie le nombre supplémentaire de tentatives lors de l'établissement du tunnel SSH si ce dernier n'arrive pas à être établi

Code Block
ssh_user
TexteUtilisateur unixshinkenL'utilisateur avec lequel le tunnel sera établi
Code Block
ssh_keyfile
TexteChemin de fichier~shinken/.ssh/id_rsa La clé ssh privée présente sur le serveur Shinken qui sera utilisé pour établir le tunnel.
Code Block
ssh_tunnel_timeout
EntierSsecondes10Spé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 l'utilisateur 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 MongoDB
  • Code Block
    languagebash
    titleCopie de la clé SSH
    root@serveur_shinken # su - shinken
    shinken@serveur_shinken $ ssh-keygen
    shinken@serveur_shinken $ ssh-copy-id user_distant@serveur_mongo 
    [...]
    shinken@serveur_shinken $ ssh user_distant@serveur_mongo
    user_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

    Code Block
    languagejs
    themeConfluence
        # ──────────────  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.
    Info
    titleDé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 : ( voir la page 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é 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 "event-manager-reader" 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.


    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
    auto_reconnect_max_try
    EntierNombre d'essais4Nombre d'essais de reconnexion à la base
    code
    No Format
    auto_reconnect_sleep_between_try
    Entier Secondes3

    Temps entre chaque essai en seconde


    Les valeurs par défauts du fichier laisse laissent 12 secondes, ce qui est amplement suffisant avec la configuration par défaut de MongoDB.


    Warning

    Il est conseillé de ne pas modifier ces valeurs.

    Configuration pour l'interface de visualisation

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ─────────────────────────────────────    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.

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
    broker__module_webui__module_event_manager_reader__events_export__max_retry
    EntierNombre d'essais2

    Nombre d'essais d'appel pour l'export des données vers Excel.

    Ne peut pas valoir 0.

    Options Internes

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ─────────────────────────────────────    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
    Warning

    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é. 

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
     time_before_shinken_inactive 
    Entier Secondes30

    Temps d'inactivité du Broker avant de considérer que Shinken est inactif.

    Utilisez cette option si

    vous avez un

    le temps de boucle du Broker

    qui

    dépasse 30 secondes.