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 ]          # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE OPTIONS    ─────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Number of day the events are kept in database                                                     ───
    #                                                                                                       ───
    #          Default : 30 ( days )                               [ MANDATORY ] ───
    # ───                                 ───
    #                                                              ───
    module_name                                     ───
    # day_keep_dataevent-manager-writer

    # ─── Module type [ Do not edit ]                            30

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

[ MANDATORY ] ───
 # ─────────────────  MongoDB# parameters───  ────────────────────────────────────────────────────────────────── 

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #module_type                                         event_container

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

    # ─── Number of day the events are kept in database                   ───
    #          Default : mongodb://localhost/?w=1&fsync=false                  ───
    #                         ───
    #                                                                          ───
    #           Default : 30 ( days )         ───
    # uri                                                 mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains───
 events data  # ───                                                            ───
    #                                   ───
    # day_keep_data                                       30

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

    # ─────────────────  MongoDB Defaultparameters : event_container ──────────────────────────────────────────────────────────────── #

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

    # ─── SSH tunnel activation to secure your mongodb connection                              ───
    # ───        ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                                        ───
    # uri                                                 mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains ───
events data   #          ...     : Enable  => 1 ( enable ssh tunnel )                                    ───
    #         ───
    #          Default : Disable => 0 ( disable ssh tunnel )                                                ───
    #                   ───
    #           Default : event_container                                                                   ───
    # use_ssh_tunnel───                                      0

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

    # ─── username/password to authenticate to MongoDB.      ───
    #          Default : 1 ( try )                            ───
    # ─── Both parameters must be provided for authentication to         function correctly.                        ───
    #    ───                                                                                                   ───
    # use_ssh_retry_failure  broker__module_event_manager_writer__database__username

    # ───                             1

     # ─── SSH user to connect to the mongodb server.                                                        ───
    # 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                              ───
    #            Default : shinken                                                                            ───
    #         ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )                                                ───
    #           Default : ───
Disable => 0 ( #disable ssh_user tunnel )                                               shinken
───
    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                                  ───
    # use_ssh_tunnel                                      0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure         time before_shinken_inactive   ───
    #          Default : ~shinken/.ssh/id_rsa                                                               ───
    #                        ───
    #           Default : 1 ( try )                                                           ───
    # ssh_keyfile         ───
    # ───                           ~shinken/.ssh/id_rsa

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

    # ─── SSH user to connect to the mongodb server.                                  ───
    #          Default : 10 ( seconds )   ───
    #                                                              ───
    #                                     ───
    #           Default : shinken                                                 ───
     # 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  # ssh_user                                            ───shinken

    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                                     ───
            #          Default : 4 ( try )                                       ───
    #           Default : ~shinken/.ssh/id_rsa                  ───
          #                                  ───
    # ───                                                                ───
    # auto_reconnect_max_try                              4
───
    # ─── Time between each try ssh_keyfile                                         ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 310 ( seconds )                                                                      ───
    #    ───                                                                                                   ───
    # autossh_reconnect_sleep_between_trytunnel_timeout                    3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                       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 heartbeatTimeoutSecswill ofraised yourthe MongoDB AutoReconnect exception. replica set                     ───

    # ─── How many try to reconnect before module go in error        ───
    # ───       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.     ───
    #           Default : 4 ( try  )      ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.            ───
    #                               ───
    # ───                                                                   ───
    #          Default : 1 ( worker )             ───
    # auto_reconnect_max_try                              4

    # ─── Time between each try               ───
    #                                                          ───
    #                                         ───
    # broker_module_nb_workers                            1

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    INTERNAL OPTIONS    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
───
    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATEDDefault SUPPORT: 3 ( seconds    )                  ───

    # ─── Broker idle time before considering that Shinken is inactive.                                     ───
    # ─── Use this if you have Broker loop time that exceeds 30 seconds                                     ───
    #                                              ───
    # auto_reconnect_sleep_between_try                    3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the            ───
    #   ───
    # ───  Default : 30 ( seconds )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  # time_before_shinken_inactiveis used by the broker to set the number of workers.                                30

}