Page History

# 

# =============================================================================================================== #
# -------------------------------        livedata_module_sla_provider        -------------------------------- #
# =========================================================================================================== #
# --- Daemons that can load this module:                                                                    ---
# ---   => broker-module-livedata                                                                           ---
# --- This module is an API providing information on SLA of moditored elements                              ---
#============================================================================================================ #

define module {

    # ==========================================   Module identity   ======================================== #
    # --- Module name [ Must be unique ]                                                                    ---
    module_name                                       livedata-module-sla-provider

    # --- Module type [ Do not edit ]                                                                       ---
    module_type                                       livedata_module_sla_provider


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

    # =================  Mongo parameters  ===================                                                #
	#                                                                                                         #
    # --- Mongodb uri definition 																			---
    # >>> DEFAULT : mongodb://localhost/?w=1&fsync=false                                                    ---
    livedata_module_sla_provider__uri                  		                              mongodb://localhost/?w=1&fsync=false
	
	# --- Which database contains sla data           												        ---
    # >>> DEFAULT : shinken                                                                                 ---
    livedata_module_sla_provider__database             			                          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                                                                                       ---
    # 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 : 10                                  												     ---
    # livedata_module_sla_provider__database__wait_X_seconds_before_reconnect                  10

	
    # ========  SSH Tunnel for Database connection  ==========                                                #
	#                                                                                                         #
    # --- SSH tunnel activation to securize your mongodb connection  										---
	# --- That will allow all mongodb to be encrypted & authentificated with SSH 							---
    # >>> Disabled  : 0 ( DEFAULT )                         												 ---
    # --- Enabled   : 1                                     												---
    # livedata_module_sla_provider__use_ssh_tunnel          	                             0
  
    # --- SSH user to connect to the mongodb server.       													---
    # >>> DEFAULT : shinken                                 												 ---
    # livedata_module_sla_provider__ssh_user                	                             shinken
     
    # --- SSH keyfile to connect to the mongodb server.     												---
    # >>> 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                                                                                      ---
    # livedata_module_sla_provider__ssh_tunnel_timeout  		                             10
  

    # ======================================================================================================= #
    # ----------------------------------------    SLA calculation   ----------------------------------------- #
    # ------------------------------------------------------------------------------------------------------- #
	#                                                                                                         #
    # --- Some status can impact                                                                            ---
    # ---     Positively ( counted as OK / UP ) 										                    ---
	# ---     Negatively ( counted as CRITICAL / DOWN )                                                     ---
    # ---     or not impact the SLA ( is not counted, meaning the period of study is reduced by the period  ---
    # ---     that is not counted )                                                                         ---
    # ---                                                                                                   ---
    # --- 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 )  ==========                  #
	#                                                                                                         #
    # >>>    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
  
}