Page History

Pour que la fonctionnalité de bac à événement puisse afficher des événements à jour, il faut absolument que ce module soit activé sur un Broker pour écrire les évènements en base.

 Il ne peut y avoir qu'un event-manager-writer par base MongoDB.

• Donc, pour avoir plusieurs modules qui écrivent sur le même serveur MongoDB, il faut les configurer pour écrire dans des bases différentes ( voir le paramètre database ci-dessous ).
• Cependant, il est fortement déconseillé de configurer plusieurs modules sur un même serveur MongoDB, en raison des ressources qu'un module peut requérir ( bande passante disque et occupation disque )

service shinken-arbiter restart

define broker {
    [...]
    modules                   Module 1, Module 2, Module 3, event-manager-writer
    [...]
}

service shinken-arbiter restart

#================================================================================
# event manager
#================================================================================
# Daemons that can load this module:
#  - broker (to save events information into a mongodb database)
# This module compute and save event for event manager
#================================================================================

define module {

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

    # ─── Module name [ Must be unique ]                                       ───
    # >>> Disable : 0 ( disable ssh tunnel ) ( Default )                                                    ───
    # 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                          [ MANDATORY ] 1───

    # ─── SSH user to connect to the mongodb server.                                                        ───
    # >>> Default : shinken                           ───
    module_name                                         event-manager-writer

    # ─── Module type [ ───
Do not edit ] # ssh_user                                          shinken

    # ─── SSH keyfile to connect to the mongodb server.[ MANDATORY ] ───
    # ───                                             ───
    # >>> Default : ~shinken/.ssh/id_rsa                                              ───
    module_type                  ───

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.   event_container

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE OPTIONS    ─────────────────────────────────────── │ ───#
    # >>>└─────────────────────────────────────────────────────────────────────────────────────────────────────┘ Default#

 : 10 ( seconds# )─── Number of day the events are kept in 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 : 30 ( ───
days )   # ───                                                                   ───
    # ───                           ───
    # ─── How many try to reconnect before module go in error                                               ───
    # >>> Default : 4 ( try───
 )   # day_keep_data                                       30

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

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at              4

    # ─── Time between each try            ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #                 ───
    # >>> Default : 3 ( seconds )                                                                           ───
    # auto_reconnect_sleep_between_try          Default : mongodb://localhost/?w=1&fsync=false      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.  ───
    # uri                  ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────    WORKERS IN THE BROKER    ─────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # mongodb://localhost/?w=1&fsync=false

    # ─── ThisWhich moduledatabase willcontains useevents workersdata in the broker, each worker will manage a shard of all hosts/checks.  ───
    # ─── This parameter is used by the broker to set the number of workers.                                ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.                                                            ───
    # >>> Default : 1 ( worker )                                ───
    #           Default : event_container                           ───
    # broker_module_nb_workers                          1

                                        ───
    # ───                                                                                                   ───
    # database                                            event_container

    # ─── username/password to authenticate to MongoDB.                                                     ───
    # ─── Both parameters must be provided for authentication to function correctly.                        ───
    # ───                                                                                                   ───
    # broker__module_event_manager_writer__database__username

    # ───                                                                                                   ───
    # broker__module_event_manager_writer__database__password

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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────    WORKERS IN THE BROKER    ─────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── This module will use workers in the broker, each worker will manage a shard of all hosts/checks.  ───
    # ─── This parameter is used by the broker to set the number of workers.                                ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.            ───
    #                                                                                                       ───
    #           Default : 1 ( worker )                                                                      ───
    # ───                                                                                                   ───
    # broker_module_nb_workers                            1

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

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT                         ───

    # ─── Broker idle time before considering that Shinken is inactive.                                     ───
    # ─── Use this if you have Broker loop time that exceeds 30 seconds                                     ───
    #                                                                                                       ───
    #           Default : 30 ( seconds )                                                                    ───
    # ───                                                                                                   ───
    # time_before_shinken_inactive                        30

}

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE OPTIONS    ─────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
 
    # ─── Number of day the events are kept in database                                                     ───
    #                                                                                                       ───
    #          Default : 30 ( days )                                                                        ───
    #                                                                                                       ───
    # day_keep_data                                       30

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

    # ─── username/password to authenticate to MongoDB.                                                     ───
    # ─── Both parameters must be provided for authentication to function correctly.                        ───
    # ───                                                                                                   ───
    # broker__module_event_manager_writer__database__username

    # ───                                                                                                   ───
    # broker__module_event_manager_writer__database__password

    # ─── 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 la page Haute disponibilité de la base MongoDB (mise en place d'un cluster) )

Il est conseillé de ne pas modifier ces valeurs.

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────────────────────────────────────────    MODULE OPTIONSWORKERS IN THE BROKER    ────────────────────────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
 
    # ─── NumberThis ofmodule daywill the events are keepuse workers in databasethe broker, each worker will manage a shard of                                             all hosts/checks.  ───
    # >>> Default : 30 ( days )             ─── This parameter is used by the broker to set the number of workers.                                ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.            ───
    #   day_keep_data                                     30

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

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT                  ───
    #   ───

    # ─── Broker idleDefault time: before1 considering( thatworker Shinken) is inactive.                                     ───
    # ─── Use this if you have Broker loop time that exceeds 30 seconds               ───
    #                  ───
    # >>> Default : 30 ( seconds )                                                                          ───
    # timebroker_beforemodule_shinken_inactivenb_workers                            30

}

Ne pas dépasser le nombre de core cpu de la machine : cela serait contre-productif pour les performances.

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    INTERNAL OPTIONS    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
 
    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT

Ces paramètres sont dédiés au fonctionnement interne au module, il est fortement recommandé de ne pas les modifier sans le support dédié.