Page History

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

Si vous avez plusieurs configurations de du module WebUI 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.

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

service shinken-arbiter restart

# 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 ───
    # ───  ───
    # ───heartbeatTimeoutSecs of events.your ThisMongoDB willreplica makeset the export more tolerant to network loss 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,          ───
    # ─── or restart of the broker.    Default : 2 ( try )                                                                ───
    # ─── 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

}

                                                           ───
    #           Default : 30 ( seconds )                                                                    ───
    # ───                                                                                                   ───
    # time_before_shinken_inactive                        30

} 

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

• 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) )

Il est conseillé de ne pas modifier ces valeurs.

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    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é.