Page History

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

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

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

#================================================================================
# 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
# CFG_FORMAT_VERSION 1
#================================================================================

define module {

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

    # ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
    # broker__module_webui__module_event_manager_reader__database__username

    # ───                                                                                                   ───
    # broker__module_webui__module_event_manager_reader__database__password

    # ─── SSH tunnel activation to secure your mongodb connection        ───
    module_name                               ───
    # ─── That will allow  event-manager-reader

    # ─── Module type [ Do not edit ]all mongodb to be encrypted & authenticated with SSH                              ───
    #                            [ MANDATORY ] ───
    # ───                                                                   ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )   ───
    module_type                                         event_container───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐  #
    # │ ────────────────────────────────────  Default : DATABASEDisable CONNECTION=> 0 ( disable ────────────────────────────────────ssh │tunnel #
)    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

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

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

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #   ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #                                 ───
    #           Default : 1 ( try )                                                  ───
    # uri                  ───
    # ───                          mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains events data                                                               ───
    # use_ssh_retry_failure                               1

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #    ───
    #           Default : event_container                                                                   ───
    #           ───
    #           Default : shinken                                                                           ───
    # database ───                                           event_container

    # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ───ssh_user   That will allow all mongodb to be encrypted & authenticated with SSH                              ───shinken

    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                                     ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )                                     ───
    #       ───
    #Default     : ~shinken/.ssh/id_rsa      Default : Disable => 0 ( disable ssh tunnel )                                               ───
    # ───                                                                                                      ───
    # use_ssh_tunnelssh_keyfile                                         0~shinken/.ssh/id_rsa

    # ─── If the SSH connectionTimeout goesused wrong,to thentest retry use_ssh_retry_failure time before_shinken_inactive   ───
    #if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                          ───
    #           Default : 1 ( try )         ───
    #           Default : 10 ( seconds )                                            ───
    #                    ───
    # ───                                                                              ───
    # use_ssh_retry_failure                ───
    # ssh_tunnel_timeout          1

    # ─── SSH user to connect to the mongodb server.           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 : shinken             ───
    # ─── How many try to reconnect before module go in error                                               ───
    #                                                                                                       ───
    # ssh_user          Default : 4 ( try )                             shinken

    # ─── SSH keyfile to connect to the mongodb server.                               ───
    # ───                 ───
    #                                                                              ───
    # auto_reconnect_max_try                    ───
    #      4

    # Default─── : ~shinken/.ssh/id_rsa   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 : 3 ( seconds )                                          ───
    #                       ───
    # ───                                                                           ───
    #           Default : 10 ( 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.     ───
    # ssh_tunnel_timeout               ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    VISUALISATION UI  10

  ────────────────────────────────────── │ #
 ──────────────  AutoReconnect Management# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ ───────────────────────────────────────────────────────────── #

    # ─── WhenSpecify MongoDBthe requiremax youretries towhen reconnectthe (Visualisation ForUI example, It can't occurcommunicate whenwith a new PRIMARY is elected   the event_manager_reader ───
    # ─── induring athe MongoDBExcel clusterexport. ), it will raised the MongoDB AutoReconnect exception.                       ───
    # ───                                      ───
    # ─── 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,          ───
    # ─── Howor manyrestart tryof tothe reconnectbroker. before module go in error                                               ───
    #                 ───
    # ─── The value cannot be 0.                                                                            ───
    #           Default : 4 ( try )                                                                         ───
    #          ───
    #           Default : 2 ( try )                                                                         ───
    # auto_reconnect_max_try───                              4

    # ─── Time between each try                                                                             ───
    # broker__module_webui__module_event_manager_reader__events_export__max_retry 2

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────                   DEFAULT NOTIFICATIONS OPTIONS    ─────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── The parameters below allow users to change default configuration of notification for Events list  ───

    # ───────────  Sound Notification Parameters  ─────────────────────────────────────────────────────────── #

    # ─── Sound notification on new event               ───
    #           Default : 3 ( seconds )                                ───
    #                                 ───
    #                                                                  ───
    #           Default : 0 => Disable ( Sound notification is not played )           ───
    # auto_reconnect_sleep_between_try                 ───
   3

 #   # ─── NOTE: Change these values only if you... have a MongoDB cluster and: you1 change=> theEnable ( Sound notification is played )             ───
    # ───       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.                         ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled 0

    # │───────────  ─────────────────────────────────────Visual Notification Parameters  VISUALISATION────────────────────────────────────────────────────────── UI#

    ──────────────────────────────────────# │─── #
Visual notification on new #event   └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── 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 : 0 => Disable ( Visual notification is not played )                                ───
    #         ───
  ...  # ─── The value: cannot1 be=> 0.Enable ( Visual notification is played )                                     ───
    # ───                            ───
    #                                                                   ───
    # broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 0

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

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DefaultDEDICATED : 2SUPPORT ( try )                      ───
    # ─── Broker idle time before considering that Shinken is inactive.                                     ───
    # ─── 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 NOTIFICATIONS OPTIONS    ─────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── The parameters below allow users to change default configuration of notification for Events list  ───

    # ───────────  Sound Notification Parameters  ─────────────────────────────────────────────────────────── #

    # ─── Sound notification on new event  ───
    #           Default : 30 ( seconds )                                             ───
    #                   ───
    # ───                                                                               ───
    #           Default : 0 => Disable (───
 Sound notification is not played )# time_before_shinken_inactive                                  ───
    #           ...     : 1 => Enable ( Sound notification is played )                                      ───30

}

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

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                ───
    # broker__module_webui__module_event_manager_reader__default_notifications_settings__sound__enabled 0
 ───
    # ───────────  Visual Notification Parameters  ────────────────────────────────────────────────────────── #

    # ─── Visual notification on new event                                                                  ───
    #               ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    # ───                     ───
    #           Default : 0 => Disable ( Visual notification is not played )                                    ───
    #           ... ───
    :# 1uri => Enable ( Visual notification is played )                                 ───
    #    mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains events data                                                               ───
    #                      ───
    # broker__module_webui__module_event_manager_reader__default_notifications_settings__visual__blink__enabled 1

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

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT                         ───
    # ─── Broker
 idle time before considering# that Shinken is inactive.       Default : event_container                            ───
    # ─── Use this if you have Broker loop time that exceeds 30 seconds                      ───
    # ───          ───
    #                                                                                     ───
    # database             ───
    #           Default : 30 ( seconds )           event_container  

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

}