Page History

# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

#================================================================================
# livedata_module_sla_provider
#================================================================================
# Modules that can load this module:
# - broker-module-livedata (to add new route to this module)
# This module is an API providing information on SLA of monitored elements
#================================================================================

define module {

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

    # ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_name                                         livedata-module-sla-provider

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_type                                         livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    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                                              ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__uri         mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                                                                  ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__name        shinken

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

    # ───     Default : 0 => Disable ( disable ssh tunnel )                                               ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )         ───
                    # broker__module_livedata__module_sla_provider__database__password

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

    # ─── SSH user to connect to the mongodb server.                                             ───
    #       ───
    #Default : 0 => Disable ( disable ssh tunnel )                                               ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                  ───
    #           Default : shinken                                                                           ───
    # ───                                                                                                      ───
    # broker__module_livedata__module_sla_provider__use_ssh_user              shinkentunnel 0

    # ─── SSH keyfileuser to connect to the mongodb server.                                                        ───
    #                                                                                                       ───
    #           Default : ~shinken/.ssh/id_rsashinken                                                              ───
    #         ───
    # ───                                                                                         ───
    # livedata      ───
    # broker__module_livedata__module_sla_provider__ssh_user shinken

    # ─── SSH keyfile to connect to the mongodb server.      ~shinken/.ssh/id_rsa

     # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 10 ( seconds )~shinken/.ssh/id_rsa                                                                      ───
    #   ───                                                                                                    ───
    # broker__module_livedata__module_sla_provider__ssh_tunnel_timeoutkeyfile ~shinken/.ssh/id_rsa

    10

# ─── SSH Timeout #used ──────────────to test AutoReconnectif Managementthe SSH ───────────────────────────────────────────────────────────────tunnel 

is viable or not, #in ───seconds. 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 : 10 ( seconds  )                                                                           ───
    # ───          Default : 4 ( number of try )                                                               ───
    #               ───
    # broker__module_livedata__module_sla_provider__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 # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try                 reconnect before module go in error                                                                ───
    #                                                                                                       ───
    #           Default : 34 ( secondsnumber )of try  )                                                                  ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__retry_waitconnection_X_secondstimes_before_reconnect 3considering_an_error 4

    # ─── NOTE:Time Changebetween theseeach valuestry only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your MongoDB replica set                              ───
    #          ───
    # ───       The value of                                                                                ───
    # ───        retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
 Default : 3 ( seconds )     # ───       must be higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )  ───
    # ───                           ───
    #                                                                    ───
    # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your DefaultMongoDB :replica includeset => Only status is considered. "Missing data" and "Shinken inactive"       ───
    #                       ───
    # ───    status are counted negativelyThe invalue theof SLA.                              ───
    #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
    # ───       retry_connection_X_times_before_considering_an_error *   ...     : okwait_X_seconds_before_reconnect      ───
    # ───       must  => No_data are considered as UP periodsbe higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ ───#

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #                                                       ───
    # livedata_module_sla_provider__no_data_period                                             ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"       include

}

───
    #                                status are counted negatively in the SLA.                              ───
    #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
    #           ...     : ok      => No_data are considered as UP periods.                                  ───
    # ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__no_data_period include

}
 

 	# ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                                                                                                       ───
    #           Default : 0 => Disable ( disable ssh tunnel )                                               ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                                                ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__use_ssh_tunnel        0
 
    # ─── SSH user to connect to the mongodb server.                                                        ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__ssh_user              shinken
 
    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                                                                                                       ───
    #           Default : ~shinken/.ssh/id_rsa                                                              ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__ssh_keyfile           ~shinken/.ssh/id_rsa
 
    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 10 ( seconds )                                                                    ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__ssh_tunnel_timeout    10ssh_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 ( number of try )                                                               ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4
 
    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : 3 ( seconds )                                                                     ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 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                                                                                ───
    # ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
    # ───       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.

 	# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
 
    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #                                                                                                       ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"       ───
    #                                status are counted negatively in the SLA.                              ───
    #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
    #           ...     : ok      => No_data are considered as UP periods.                                  ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__no_data_period        include