Page History

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

• Donc,

• soit, vous n'activez le module que sur un Broker
• soit, vous configurez le module pour écrire dans une autre base.

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

#================================================================================
# 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 type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_type                                         event_container

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

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

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

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

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    #module_type  ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───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 parameters  ──────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at      ───
    #          Default : event_container             ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #          ───
    #                                                                                         ───
    #          ───
 Default :  # databasemongodb://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.                                                     ───
    # ─── Both parameters must be provided for authentication to Defaultfunction :correctly. 1 ( try )                    ───
    # ───                                                 ───
    #                                              ───
    # broker__module_event_manager_writer__database__username

    # ───                                               ───
    # use_ssh_retry_failure                               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 tunnel )                                               ───
    # ssh_user───                                            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.ssh_user                                            ───shinken

    # ─── SSH Howkeyfile manyto tryconnect to the mongodb server. reconnect before module go in error                                               ───
    #                                                                                                       ───
    #           Default : 4 ( try )~shinken/.ssh/id_rsa                                                              ───
    # ───         ───
    #                                                                                      ───
    # ssh_keyfile            ───
    # auto_reconnect_max_try                              4~shinken/.ssh/id_rsa

    # ─── TimeSSH betweenTimeout eachused tryto test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                    ───
    #                                                               ───
    #           Default : 10 ( seconds )                    ───
    #          Default : 3 ( seconds )                             ───
    # ───                                    ───
    #                                                           ───
    # ssh_tunnel_timeout                                       ───10

    # auto_reconnect_sleep_between_try──────────────  AutoReconnect Management  ───────────────────────────────────────────────────────────── #

    # ─── When MongoDB require you to reconnect (  3
For example, It can occur when a new PRIMARY is elected   ───
    # ─── NOTE:in Changea theseMongoDB valuescluster only), ifit youwill haveraised athe MongoDB AutoReconnect clusterexception. and you change the                   ───

    # ─── How many try to reconnect before module heartbeatTimeoutSecsgo ofin yourerror 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. Default ───
: 4 (  # ─── This parameter is used by the broker to set the number of workers.try )                                         ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.            ───
    # ───                                                                                                      ───
    # auto_reconnect_max_try         Default : 1 ( worker )                4

    # ─── Time between each try                                              ───
    #                           ───
    #                                                                        ───
    # broker_module_nb_workers                            1
───
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────   Default INTERNAL: OPTIONS3 ( seconds ) ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────    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.                    ───
    # time_before_shinken_inactive       ───
    # ─── Each worker will use one CPU, which will balance the event processing load among CPUs.    30

}