Page History

S'il y a plusieurs modules broker-module-livedata présents dans l'architecture, il ne faut pas oublier d'activer le module de type livedata_module_sla_Si vous avez plusieurs modules broker-module-livedata présents dans votre architecture, n'oubliez pas d'activer le module livedata-module-sla-provider dans la configuration de chacune d'elles.

# 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 ]                                                  ───
    module_name                                         livedata-module-sla-provider

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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    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_name                                         livedata-module-sla-provider

    # ─── Module type [ Do not edit ]                                                  ───
    #   [ MANDATORY ] ───
    # Default─── : mongodb://localhost/?w=1&fsync=false                                              ───
    #                                               ───
    module_type                                         livedata_module_sla_provider

    #       ───┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # livedata_module_sla_provider__database__uri │ ────────────────────────────────────    DATABASE CONNECTION   mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

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

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

    # ─── Which shinken

database contains sla data # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ─── That will allow all mongodb to be encrypted───
 & authenticated with SSH#                              ───
    #                                                                     ───
    #           Default : shinken                 ───
    #           Default : 0 => Disable ( disable ssh tunnel )                                  ───
    # ───        ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                                                ───
    #          ───
    # broker__module_livedata__module_sla_provider__database__name shinken

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

    # ───     SSH user to connect to the mongodb server.                                                        ───
    #                           ───
    # broker__module_livedata__module_sla_provider__database__username

    # ───                                                                  ───
    #           Default : shinken                ───
    # 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__ssh_user              shinken

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

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

    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    # 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 reconnect before module go in error      ───
    #           Default : ~shinken/.ssh/id_rsa                        ───
    #                                  ───
    # ───                                                                ───
    #           Default : 4 ( number of try )             ───
    # 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.                          ───
    #                                                                                                       ───
    # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try Default : 10 ( seconds   )                                                                     ───
    #    ───                                                                                                   ───
    #        broker__module_livedata__module_sla_provider__ssh_tunnel_timeout 10

   Default :# 3────────────── ( secondsAutoReconnect )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                                               ───
    #                                          ───
    # 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   #           Default : 4 ( number of try )                        ───
    # ───       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.     ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try               SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #                                                                                                       ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"3 ( seconds )               ───
    #                                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__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                                                                                ───
    # livedata_module_sla_provider__no_data_period  ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      include

}

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax atname                 shinken
 
    # --- if the module encounter an issue to connect on the database, it will retry X times before         ---
    # --- considering it as a connexion error                                                               ---
    # >>> DEFAULT : 2                                                               ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                  ---
    # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error    3
 
    # --- If the module face a───
 connection error to the# database, it restart the connection process          ---
    # --- after X seconds                                                                               ───
    ---
#    # >>> DEFAULT : 10       Default : mongodb://localhost/?w=1&fsync=false                                              ───
    # ───                                                                        ---
     # livedata_module_sla_provider__database__wait_X_seconds_before_reconnect                  10     

	[...]

}

 	# ─── SSH tunnel activation to secure your mongodb connectionssh_keyfile                                              ~shinken/.ssh/id_rsa
   
    # --- SSH Timeout used to test if the SSH tunnel is viable or not, in seconds                           ---
    # >>> DEFAULT : 10                                                                                      ---
    # 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 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 )                                                                     ───
    # 

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

 	# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #                                                                 ---
    # --- This configuration aims at giving Shinken administrators a way to configure│ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
 
    # ---
    # --- how the SLA are calculated.─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #                                 ---
   
    # ========  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.  #
    # >>>    include: ( DEFAULT ) Only status is considered.            ───
    #           ...     : exclude => No_data are not counted from SLA considered period.      ---
    # ---       note: "Missing data"───
 and "Shinken inactive" status# are counted negatively in the SLA.     ...  ---
   : #ok ---    exclude: => No_data are notconsidered countedas fromUP SLAperiods. considered period                                   ---───
    # ---    ok:       No_data are considered as UP periods                                                 ---
    # livedata_module_sla_provider__no_data_period                                ───
    # broker__module_livedata__module_sla_provider__no_data_period      include
 	
	[...] 

} include