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

Le module MongoDB est un module qui permet au module WebUI ( l'interface de visualisation ) du Broker d'accéder aux données stockées dans la base de données MongoDB.

Warning

Ce module est obligatoire pour pouvoir accéder à l'interface de visualisation.


Info

Si vous avez plusieurs configurations de WebUI présente dans votre architecture, n'oubliez pas d'activer le module dans chaque configuration

  • Exemple plusieurs WebUI sur le même broker
  • ou une sur différents Brokers qui n'utilise pas la même définition.


Activation du module

Le module MongoDB 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 se faire, ouvrez le fichier de configuration du module WebUI à l'emplacement /etc/shinken/modules/nom_du_module_webui.cfg , et ajouter le nom de votre module .


Exemple: par défaut, nous livrons un module dont le nom est "Mongodb":

Code Block
languagebash
define module {
    [...]
    modules                   Module 1, Module 2, Module 3, Mongodb
    [...]
}


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


Code Block
service shinken-arbiter restart


Configuration

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/mongodb.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/mongodb-example.cfg

Exemple de fichier de configuration


Code Block
bash
bash
#================================================================================
# Mongodbdiscovery
#================================================================================
# Modules that can load this module:
#  - WebUI
# This module is mandatory for the WebUI module. The WebUI use this definition
# to access the
# mongodb data (like hive and user shares)
# 
#================================================================================


define module {
#
 Shinken Enterprise. Lines added# by┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ import#
 core. Do not remove# it, it's used by Shinken Enterprise to update your objects if you re-import them.│ ──────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────── │ #
    _SE_UUID# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must  core-module-5dfa7f645adc11e5ad8e080027f08538
 be unique ]   _SE_UUID_HASH        9068b8f577e092efe14d185538fbdb6d
# End of Shinken Enterprise part


    #======== Module identity =========
    # Module name. Must be unique
    module_name     Mongodb

    # Module type (to load module code). Do not edit.
[ MANDATORY ] ───
 module_type   # ─── mongodb



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

    # If you want    to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
    # allow all mongodb to be encrypted & authentificated with SSH
    # Should use a SSH tunnel (Default 0=False) ───
    # use_ssh_tunnelmodule_name          0

    # If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive
    # Default: 1
    # use_ssh_retry_failure      1Mongodb

    # SSH─── user/keyfileModule intype order[ toDo connectnot toedit the] mongodb server.
    # Default: shinken
    # ssh_user                shinken

    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa

    #[ TimeoutMANDATORY in] order───
 to establish a connection, in seconds
# ───                                   # Default: 10
    # mongo_timeout  10

    # Which database is used to store sla data
    database        shinken
}

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type "mongodb" dans votre architecture Shinken.

  • Chaque instance devra avoir un nom unique.
NomTypeUnitéDéfautCommentaire
Code Block
module_name 
Texte---Mongodb

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---mongodb

Ne peux ê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é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
Code Block
languagejs
themeConfluence
	#======== Database connection =========
    # mongodb uri definition for connecting to the mongodb database. You can find the mongodb uri
    # syntax at https                               ───
    module_type                                         mongodb

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    DATABASE CONNECTION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . 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

   

NomTypeUnitéDéfautCommentaire
Code Block
 uri 
TexteURLmongodb://localhost/?safe=true

Vous pouvez trouver la syntaxe de l'uri de MongoDB à l'adresse https://docs.mongodb.com/manual/reference/connection-string/

Code Block
 database 
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 pour y lire et écrire les données.

Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le paramètre "use_ssh_tunnel" est à 0.

Cette méthode de connexion a pour avantage d'être facile à configurer au niveau de Shinken. Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.

La sécurisation de la base MongoDB est bien sur toujours possible (voir Sécurisation des connexions aux bases MongoDB) mais bien plus complexe à mettre en place. La méthode de connexion par SSH est donc préférable pour des raisons pratiques et de sécurité.

Connexion par SSH au serveur MongoDB
                                      ───
    #                                                                                                       ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #                                                                                                       ───
    # mongodb__database__uri                              mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains events data                                                               ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    #                                                                                                       ───
    # mongodb__database__name                             shinken

    # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                                                                                                       ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )                                                ───
    #           Default : Disable => 0 ( disable ssh tunnel )                                               ───
    #                                                                                                       ───
    # mongodb__database__use_ssh_tunnel                   0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #                                                                                                       ───
    #           Default : 1 ( try )                                                                         ───
    #                                                                                                       ───
    # mongodb__database__use_ssh_retry_failure            1

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    #                                                                                                       ───
    # mongodb__database__ssh_user                         shinken

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

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 10 ( seconds )                                                                    ───
    #                                                                                                       ───
    # mongodb__database__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 : 5 ( try )                                                                         ───
    #                                                                                                       ───
    # mongodb__database__retry_connection_X_times_before_considering_an_error 5

    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : 5 ( seconds )                                                                     ───
    #                                                                                                       ───
    # mongodb__database__wait_X_seconds_before_reconnect  5

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your MongoDB replica set                                            ───
    # ───       The value of mongodb__database__retry_connection_X_times_before_considering_an_error *      ───
    # ───       mongodb__database__wait_X_seconds_before_reconnect must be higher than heartbeatTimeoutSecs ───
    # ───       in the rs.conf(); of your MongoDB replica set.                                              ───

}


Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type "mongodb"   dans votre architecture Shinken .

  • Chaque instance devra avoir un nom unique.
NomTypeUnitéDéfautCommentaire


Code Block
module_name 


Texte--- Mongodb

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--- mongodb

Ne peux ê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é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


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

   


NomTypeUnitéDéfautCommentaire


Code Block
 uri 
                  
TexteURL mongodb://localhost/?safe=true

Vous pouvez trouver la syntaxe de l'uri de MongoDB à l'adresse https://docs.mongodb.com/manual/reference/connection-string/


Code Block
 database 
                  
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 pour y lire et écrire les données.

Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le paramètre "use_ssh_tunnel" est à 0.

Cette méthode de connexion a pour avantage d'être facile à configurer au niveau de Shinken. Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.

La sécurisation de la base MongoDB est bien sur toujours possible (voir  Sécurisation des connexions aux bases MongoDB) mais bien plus complexe à mettre en place. La méthode de connexion par SSH est donc préférable pour des raisons pratiques et de sécurité.

Connexion par SSH au serveur MongoDB


Code Block
languagejs
themeConfluence
    # ─── 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 de données 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 : Connection par tunnel SSH
  • 0 : Connection direct


Code Block
use_ssh_retry_failure
                  
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


Code Block
ssh_user
                  
TexteUtilisateur unix shinken L'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
 mongo_timeout 


Entiersecondes 10 Spécifie le timeout en secondes de la connexion à MongoDB
Pour configurer les clés SSH à utiliser, voir la page Création automatique et gestion de la clé SSH de l'utilisateur shinken
Gestion de la reconnexion automatique


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 : 5 ( try )                                                                         ───
    #                                                                                                       ───
    # mongodb__database__retry_connection_X_times_before_considering_an_error 5

    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : 5 ( seconds )                                                                     ───
    #                                                                                                       ───
    # mongodb__database__wait_X_seconds_before_reconnect  5

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your MongoDB replica set                                 
Code Block
languagejs
themeConfluence
 	# If you want to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
    # allow all mongodb to be encrypted & authentificated with SSH
    # Should use a SSH tunnel (Default 0=False)
    # use_ssh_tunnel          0
 ───
    # If───   the SSH connection goes wrong,The thenvalue retry use_ssh_retry_failure time before_shinken_inactive
of mongodb__database__retry_connection_X_times_before_considering_an_error *    # Default: 1───
    # use_ssh_retry_failure───   1
 
    # SSH user/keyfile in order to connect to the mongodb server.
mongodb__database__wait_X_seconds_before_reconnect must be higher than heartbeatTimeoutSecs ───
    # ───    # Default: shinken
 in   # ssh_user      the rs.conf(); of your MongoDB replica set.          shinken
 
    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa
 
    # Timeout in order to establish a connection, in seconds
    # Default: 10
    # mongo_timeout  10 ───


La reconnexion automatique permet au module de se reconnecter à Mongo dans le cas ou :

  • Il y a une perte de connexion dû à un problème réseau/un redémarrage de mongo
  • 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.


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. 

Élection : processus de MongoDB pour choisir un nouveau membre Primaire si le membre Primaire devient inaccessible 

Voir : Haute disponibilité de la base MongoDB


Dans le but de ne pas interrompre le service lorsque l'un de ces cas survient, le module "mongodb" va se reconnecter automatiquement.
Pour ce faire il va faire un nombre d' essais égal au paramètre "mongodb__database__retry_connection_X_times_before_considering_an_error " avec une pause de X secondes entre chaque essai ( correspondant au paramètre "mongodb__database__wait_X_seconds_before_reconnect"

).

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

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 de données 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 : Connection par tunnel SSH
  • 0 : Connection direct
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
 mongo_timeout 
Entiersecondes10Spécifie le timeout en secondes de la connexion à MongoDB
  mongodb__database__retry_connection_X_times_before_considering_an_error 
                  
EntierNombres d'essais 5

Nombre d'essais de reconnexion à la base


Code Block
 mongodb__database__wait_X_seconds_before_reconnect 
                  
Entier Secondes 5

Temps entre chaque essai en seconde


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


Warning

Il est conseillé de ne pas modifier ces valeurs.

Pour configurer les clés SSH à utiliser, voir la page Création automatique et gestion de la clé SSH de l'utilisateur shinken