Page History

#===============================================================================
# sla
#=========================================================
# sla
#======================
# Daemons that can load this module=========================================================
# 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

    # WhichIf databaseyou is usedwant to storesecurize slayour data
mongodb connection you can databaseenable the ssh use_ssh_tunnel that will
    # allow all mongodb shinken

to be encrypted & #usernameauthentificated with SSH
    # Should usernameuse a SSH tunnel  ;optional(Default 0=False)
    #password  # use_ssh_tunnel      password     ;optional0

    #======== Module options =========
    # Raw SLA can be kept during X days. In case of issue, these data will be used to re-perform SLA computation. If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive
    # Default: 1
    # use_ssh_retry_failure   1

    # TheSSH drawbackuser/keyfile ofin thisorder featureto isconnect thatto itthe takes more disk space.
mongodb server.
    # Default: shinken
    # #keep_raw_sla_day   7ssh_user             ;optional, defaults to 7shinken

    # Duration in day to keep SLA info,
Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile    # Default value is -1. It mean SLA are keep forever, in this case to mongo database will grow endlessly.
    # Minimal value is 7 day ~shinken/.ssh/id_rsa

    # SSH Timeout used to test if the SSH tunnel is viable or not, in seconds
    #nb_stored_days   -1
# Default: 5
    # SLAssh_tunnel_timeout are computed on a daily basis. SLA of5

 the current day are# alwaysTimeout recomputedin afterorder ato configurationestablish change.a SLAconnection, fromin daysseconds
 before are by default# notDefault: recomputed.10
    # Ifmongo_timeout 1, old10

 SLA will be recomputed# withWhich currentdatabase settings.
is used to store # If 0, old SLA will not be recalculated [default]
sla data
    database      # recompute_old_sla      0shinken

    #======== SLAModule calculationoptions =========
    # SomeRaw statusSLA can impactbe positivelykept (countedduring 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.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 Ifin 1,day Warningto countskeep asSLA UPinfo,
    # IfDefault 0,value Warning counts as DOWN [default]
    # warning_counts_as_ok   0
is -1. It mean SLA are keep forever, in this case to mongo database will grow endlessly.
    # Minimal ==value Unknownis periods7 ==day
    # #nb_stored_days   -1

 include:  Only status# isTime considered. "Unknown" status is counted negatively in the SLA. [default]of day the SLA archive cleanup is performed
    # Default value, if unset, -is exclude03:02
  Unknown are not# countedDaily fromcleanup SLAis considereddone period
at requested time when #nb_stored_days is set
  - ok: # format is HH:MM with
  Unknown are considered# as- UPHH periods
is the hour of #the unknown_periodday (an integer between 0    include
and 23)
    # - MM == No_data periods ("Missing data" and "Shinken inactive" status) ==are the minutes (an integer between 0 and 59)
    # time_when_delete_old_SLA 03:02

    # -SLA include:are computed Onlyon statusa isdaily consideredbasis. "MissingSLA data"of andthe "Shinken inactive" statuscurrent day are countedalways recomputed negativelyafter ina theconfiguration SLAchange. [default]
SLA from days before #are by default not -recomputed.
 exclude:  No_data are# notIf counted1, fromold SLA consideredwill period
be recomputed with current #settings.
    -# ok:If 0, old SLA will not be No_data are considered as UP periodsrecalculated [default]
    # norecompute_dataold_periodsla        include0

    #  ======== DowntimeSLA periods calculation ========
    # Some status can -impact include:positively (counted Only status is considered. [default]
    #    - exclude:  Downtimes areas OK/UP), negatively (counted as CRITICAL/DOWN) or not impact the SLA
    # (is not counted, frommeaning SLA consideredthe period
 of study is #reduced by the period -that ok:is not counted).
    # DowntimesThis are considered as UP periods
    #configuration aims at giving Shinken administrators a way to configure how the SLA are calculated.

    -# critical:If Downtimes1, areWarning consideredcounts as DOWN periodsUP
    # downtime_period    include
 If 0, Warning counts as DOWN [default]
    #======== INTERNAL options ========= warning_counts_as_ok   0

    #INTERNAL# : DO== NOTUnknown EDITperiods FOLLOWING==
 PARAMETRE WITHOUT YOUR DEDICATED# SUPPORT
   - #include: == timeOnly ofstatus 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 is considered. "Unknown" status is counted negatively in the SLA. [default]
    #    - exclude:  Unknown are not counted from SLA considered period
    #    - ok:       Unknown 10are 000
considered as UP periods
 # == time between# twounknown_period chunk to archive ==
    #time_between_two_chunks       0.1include

    #  == defaultNo_data valueperiods of the interval check (in minutes("Missing data" and "Shinken inactive" status) ==
    # #default_check_interval   - include:  Only status is considered. "Missing data" 5
and "Shinken inactive" status #are ==counted delaynegatively beforein the creation of missing data period (in check intervale) ==
    #margin_create_new_range       1.5SLA. [default]
    #    - exclude:  No_data are not counted from SLA considered period
    # == max delay before creating missing data period (in minutes) ==    - ok:       No_data are considered as UP periods
    #margin# no_create_new_range_maxdata_period        10include

    # Explanatory example== ofDowntime the property margin_create_new_rangeperiods ==
    #  For an element- withinclude: a checkOnly intervalstatus atis 1min and margin_create_new_range at 1.5 which equals 1min30s of time delay.
    # If the interval check is at 1h the delay would be at 1h30 but the delay is limited by margin_create_new_range_max which limits the delay to 10min.considered. [default]
    #    - exclude:  Downtimes are not counted from SLA considered period
    #    - ok:       Downtimes are considered as UP periods
    #
    #- Ancritical: OKDowntimes statusare isconsidered givenas by the scheduler at 12h30DOWN periods
    # Adowntime_period new OK status isinclude

 given by the scheduler at 12h40
    # The scheduler should have given a new status at 12h31 but it gave it at 12h40 which is 9min of time delay.
    # So that 9min > 1min30s a missing data period is created.

} #======== 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
    # == default value of the interval check (in minutes) ==
    #default_check_interval            5
    # == delay before the creation of missing data period (in check intervale) ==
    #margin_create_new_range       1.5
    # == max delay before creating missing data period (in minutes) ==
    #margin_create_new_range_max   10

    # Explanatory example of the 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.
    # If the interval check is at 1h the delay would be at 1h30 but the delay is limited by margin_create_new_range_max which limits the delay to 10min.
    #
    # An OK status is given by the scheduler at 12h30
    # A new OK status is given by the scheduler at 12h40
    # The scheduler should have given a new status at 12h31 but it gave it at 12h40 which is 9min of time delay.
    # So that 9min > 1min30s a missing data period is created.

}