Page History

Il ne peut y avoir qu'un seul module de type livedata_module_sla_provider par module broker-module-livedata.

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

#      ---
# ---   => broker-module-livedata                                                                           ---
# --- This module is an API providing information on SLA of moditored elements                              ---
#=============================================================================================
# livedata_module_sla_provider
#=================== #

define module {

    # ==========================================   Module identity   ======================================== #
    # --- Module name [ Must be unique ]                                                       
# 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                                    [ MANDATORY  livedata-module-sla-provider

] ───
    # --- Module type [ Do not edit ] ───                                                                                                   ---───
    module_typename                                         livedata_-module_-sla_-provider


    # ======================================================================================================= #
    # ------------------------------------    SLA Database connexion   -------------------------------------- #
    # ------------------------------------------------------------------------------------------------------- #

    # =================  Mongo parameters  ===================             ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                    #
	#                                                               ───
    module_type                                      #
    # --- Mongodb uri definition 																			---livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────── >>> DEFAULT : mongodb://localhost/?w=1&fsync=false DATABASE CONNECTION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                  ---
     livedata_module_sla_provider__database__uri            ───
    #  		─── https://docs.mongodb.com/manual/reference/connection-string/                               mongodb://localhost/?w=1&fsync=false
	
	# --- Which database contains sla data ───
    #      												        ---
    # >>> DEFAULT : shinken                                                                                 ---───
    livedata_module_sla_provider__database__name#           Default  			: mongodb://localhost/?w=1&fsync=false                          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           ───
    # broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                                                              ---    ───
    # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error	  2

	# --- If the module face a connection error to the database, it restart the connection process                                                        ---
    # --- after X seconds                                      ───
    #           Default : shinken                            ---
    # >>> DEFAULT : 10                                  												     ---───
    # livedata_module_sla_provider__database__wait_X_seconds_before_reconnect───                  10

	
    # ========  SSH Tunnel for Database connection  ==========                                                #
	#                    ───
    # 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.             # --- SSH tunnel activation to securize your mongodb connection  										---
	# --- That will allow all mongodb to be encrypted & authentificated with SSH 							---
───
    # ───                  # >>> Disabled  : 0 ( DEFAULT )                         												 ---
    # --- Enabled   : 1                                     												---───
    # broker__module_livedata__module_sla_provider__usedatabase_ssh_tunnelusername

    # ───     	                              0
  
    # --- SSH user to connect to the mongodb server.       													---
    # >>> DEFAULT : shinken                                 												 --- ───
    # broker__module_livedata__module_sla_provider__database_ssh_userpassword

    # ─── SSH tunnel activation to secure your mongodb connection        	                              shinken
     ───
    # --- SSH keyfile to connect─── That will allow all mongodb to thebe mongodbencrypted server.& authenticated with SSH  												---
    # >>> DEFAULT : ~shinken/.ssh/id_rsa                    												 ---───
    # 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       Default : 0 => Disable ( disable ssh tunnel )                                               ───
    #           ...     : 1  ---
=> Enable  ( enable # livedata_module_sla_provider__ssh_tunnel_timeout  		ssh tunnel )                                  10
  

    # ======================================================================================================= #
       # ---------------------------------------- ───
    # ───      SLA calculation   ----------------------------------------- #
    # ------------------------------------------------------------------------------------------------------- #
	#                                                                                  ───
    # broker__module_livedata__module_sla_provider__use_ssh_tunnel 0

    # ─── SSH user to connect to the mongodb server.     #
    # --- Some status can impact                                          ───
    #                              ---
    # ---     Positively ( counted as OK / UP ) 										                    ---
	# ---     Negatively ( counted as CRITICAL / DOWN )                      ───
    #           Default : shinken              ---
    # ---     or not impact the SLA ( is not counted, meaning the period of study is reduced by the period  ---
    # ---     that is not counted )                 ───
    # ───                                                   ---
    # ---                                           ───
    # broker__module_livedata__module_sla_provider__ssh_user shinken

    # ─── SSH keyfile to connect to the mongodb server.                                     ---
    # --- This configuration aims at giving Shinken administrators a way to configure 						---
	# --- how the SLA are calculated. 																		---
  
───
    #             # ========  No_data periods ( "Missing data" and "Shinken inactive" status )  ==========                  #
	#                                                          ───
    #           Default : ~shinken/.ssh/id_rsa                              #
    # >>>    include: ( DEFAULT ) Only status is considered. 												 ---
	# --- 	    note: "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 												---
                      # livedata_module_sla_provider__no_data_period        		                             include───
  
}

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

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

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