Page History

#===============================================================================
# sla
#===============================================================================
# Daemons that can load this module:
# - broker (to save sla information into a mongodb database)
# Modules that can load this module:
# - WebUI (to display sla data to the users)
# This module compute and save SLA values into a mongodb database
#===============================================================================


define module {

# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-d05cd3505adb11e5884b080027f08538
    _SE_UUID_HASH        05d3d1d1cce1f5e03b43936aad25e68f
# End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name          sla

    # Module type (to load module code). Do not edit.
    module_type          sla

    #======== Database connection =========
    # mongodb uri definition for connecting to the mongodb database. You can find the mongodb uri
    # syntax at https://docs.mongodb.com/manual/reference/connection-string/
    uri                  mongodb://localhost/?w=1&fsync=false

    # If you want to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
    # allow all mongodb to be encrypted & authentificated with SSH
    # Should use a SSH tunnel (Default 0=False)
    # use_ssh_tunnel          0

    # If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive
    # Default: 1
    # use_ssh_retry_failure   1

    # SSH user/keyfile in order to connect to the mongodb server.
    # Default: shinken
    # ssh_user                shinken

    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa

    # SSH Timeout in order to establish a connection used to test if the SSH tunnel is viable or not, in seconds
    # Default: 105
    # ssh_tunnel_timeout        5

    # Timeout in order to establish a connection, in seconds
    # Default: 10
    # mongo_timeout  10

    # Which database is used to store sla data
    database             shinken

    #======== Module options =========
    # Raw SLA can be kept during X days. In case of issue, these data will be used to re-perform SLA computation.
    # The drawback of this feature is that it takes more disk space.
    #keep_raw_sla_day   7            ;optional, defaults to 7

    # Duration in day to keep SLA info,
    # Default value is -1. It mean SLA are keep forever, in this case to mongo database will grow endlessly.
    # Minimal value is 7 day
    #nb_stored_days   -1

    # SLATime areof computedday onthe aSLA dailyarchive basis.cleanup SLAis ofperformed
 the current day are# alwaysDefault recomputedvalue, afterif aunset, configuration change. SLA from days before are by default not recomputed.
    # If 1, old SLA will be recomputed with current settings.is 03:02
    # Daily cleanup is done at requested time when nb_stored_days is set
    # format is HH:MM with
    # If 0, old SLA will not be recalculated [default] - HH is the hour of the day (an integer between 0 and 23)
    # recompute_old_sla      0

- MM are the minutes (an integer between 0 and 59)
    #======== SLA calculation ======== time_when_delete_old_SLA 03:02

    # SomeSLA statusare cancomputed impacton positivelya (counteddaily 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)basis. SLA of the current day are always recomputed after a configuration change. SLA from days before are by default not recomputed.
    # ThisIf configuration1, aimsold atSLA givingwill Shinkenbe administratorsrecomputed awith way to configure how the SLA are calculated.
current settings.
    # If 10, Warningold countsSLA aswill UP
not be   # If 0, Warning counts as DOWN recalculated [default]
    # warningrecompute_counts_as_okold_sla      0

    #  ======== UnknownSLA periods calculation ========
    # Some status can -impact include:positively (counted Only status is considered. "Unknown" status is counted negatively in the SLA. [default]as OK/UP), negatively (counted as CRITICAL/DOWN) or not impact the SLA
    # (is not counted, meaning the period -of exclude:study is Unknownreduced areby notthe countedperiod fromthat SLAis considerednot periodcounted).
    # This configuration aims -at ok:giving Shinken administrators a way to configure Unknownhow arethe consideredSLA as UP periodsare calculated.

    # unknown_periodIf 1, Warning counts as UP
   include

 # If 0, Warning #counts as == No_data periods ("Missing data" and "Shinken inactive" status) ==DOWN [default]
    # warning_counts_as_ok   0

    #  == Unknown - periods ==
    #    - include:  Only status is considered. "Missing dataUnknown" and "Shinken inactive" status areis counted negatively in the SLA. [default]
    #    - exclude:  No_dataUnknown are not counted from SLA considered period
    #    - ok:       No_dataUnknown are considered as UP periods
    # nounknown_data_period        include

    #  == DowntimeNo_data periods ("Missing data" and "Shinken inactive" status) ==
    #    - include:  Only status is considered. [default]
    "Missing data" and "Shinken inactive" status are counted negatively in the SLA. [default]
    #    - exclude:  DowntimesNo_data are not counted from SLA considered period
    #    - ok:       DowntimesNo_data are considered as UP periods
    # no_data_period   - critical: Downtimes are considered as DOWN periods include

    # downtime_period == Downtime periods include
==
    #======== INTERNAL options =========
    #INTERNAL : DO NOT EDIT FOLLOWING PARAMETRE WITHOUT YOUR DEDICATED SUPPORT
    # == time of inactivation of the broker before considering that shinken is inactive (in sec) ==
    #time_before_shinken_inactive  30
    # == maximum number of elements archived in one bulk pass ==
    #size_chunk_to_archive         10 000
    # == time between two chunk to archive ==
    #time_between_two_chunks       0.1 - include:  Only status is considered. [default]
    #    - exclude:  Downtimes are not counted from SLA considered period
    #    - ok:       Downtimes are considered as UP periods
    #    - critical: Downtimes are considered as DOWN periods
    # downtime_period    include

    #======== INTERNAL options =========
    #INTERNAL : DO NOT EDIT FOLLOWING PARAMETRE WITHOUT YOUR DEDICATED SUPPORT
    # == defaulttime of valueinactivation of the interval check broker before considering that shinken is inactive (in minutessec) ==
    #default#time_before_checkshinken_intervalinactive  30
    # == maximum number of elements 5
archived in one bulk #pass == delay before the creation of missing data period (in check intervale)
    #size_chunk_to_archive         10 000
    # == time between two chunk to archive ==
    #margin#time_createbetween_newtwo_rangechunks       0.1.5
    # == maxdefault delayvalue beforeof creatingthe missinginterval datacheck period (in minutes) ==
    #margin#default_create_new_range_maxcheck_interval   10

    # Explanatory example of the property margin_create_new_range 5
    # For an element with a check interval at 1min and margin == delay before the creation of missing data period (in check intervale) ==
    #margin_create_new_range at 1.5 which equals 1min30s of time delay1.5
    # If== themax intervaldelay checkbefore iscreating atmissing 1hdata theperiod delay(in would be at 1h30 but the delay is limited by marginminutes) ==
    #margin_create_new_range_max which limits the delay to 10min. 10

    #
 Explanatory example of # An OK status is given by the scheduler at 12h30
    # A new OK status is given by the scheduler at 12h40the property margin_create_new_range
    # For an element with a check interval at 1min and margin_create_new_range at 1.5 which equals 1min30s of time delay.
    # TheIf schedulerthe shouldinterval havecheck givenis a new statusat 1h the delay would be at 12h311h30 but itthe delay gaveis itlimited at 12h40by margin_create_new_range_max which islimits 9minthe ofdelay timeto delay10min.
    #
 So that 9min > 1min30s a missing data period is created.

}

define module {                                                                                         
...
...                                                                                                                                                                                                            ...
    #======== Module identity =========                                                                 
    # Module name. Must be unique                                                                       
    module_name     sla                                                                    
    ...                                                    
    use_ssh_tunnel  0
    ...                                                                                                                                                                                     

...
...
}