Page History

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

Si vous avez S'il y a plusieurs configurations de WebUI présente dans votre l'architecture, n'oubliez pas d'il faut activer 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.

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

service shinken-arbiter restart

 # CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

#

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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_name                                         Mongodb

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    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/                                      ───
    #                                                                                                       ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #    ───                                                                                                   ───
    # uri    mongodb__database__uri                                             mongodb://localhost/?w=1&fsync=false

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

    # ─── username/password to authenticate      shinken

    # ─── SSH tunnel activation to secure your mongodb connectionto MongoDB.                                                     ───
    # ─── ThatBoth willparameters allow all mongodb to must be encryptedprovided &for authenticatedauthentication withto SSH      function correctly.                        ───
    # ───                                                                                                      ───
    #           ... broker__module_webui__module_mongodb__database__username

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

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

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #           Default : 1 ( try )                                                                         ───
    # ───         ───
    #           Default : shinken                                                                           ───
    # mongodb__database__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                                           ───
    # mongodb__database__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 )                                          ───
    # mongodb__database__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 youDefault to: reconnect10 ( Forseconds 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 ───
    # 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.                       ───
    # ───                                                                    ───
    #           Default : 5 ( try )           ───
    # ─── How many try to reconnect before module go in error                                               ───
    #                                                                                                       ───
    # mongodb__database__retry_connection_X_times_before_considering_an_error 5

          # ───Default Time: between5 each( 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

          # ───Default NOTE: Change5 these( valuesseconds 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.                        ───
    # 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.                                              ───

}

    # ─── 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 : 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.                                              ───

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 (mise en place d'un cluster)

Il est conseillé de ne pas modifier ces valeurs.