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

    # 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, if not set, is -1. It means that SLA are kept forever ; in this case the mongo database will grow endlessly.
    # Minimal value is 7 day
    # If SLA are not meant to be kept forever, the following value is recommended (corresponds to 18 months)
    # nb_stored_days   547

    # SLA are computed on a daily basis. SLA of the current day are always recomputed after a configuration change. SLA from days before are by default not recomputed.
    # If 1, old SLA will be recomputed with current settings.
    # If 0, old SLA will not be recalculated [default]
    # recompute_old_sla      0

    #======== 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.

    # If 1, Warning counts as UP
    # If 0, Warning counts as DOWN [default]
    # warning_counts_as_ok   0

    #  == Unknown periods ==
    #    - include:  Only status is considered. "Unknown" status is counted negatively in the SLA. [default]
    #    - exclude:  Unknown are not counted from SLA considered period
    #    - ok:       Unknown are considered as UP periods
    # unknown_period        include

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

    #  == Downtime periods ==
    #    - 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

    #======== SLA stored output ========
    # This option enables or disables storing sla outputs.
    # If 1, the output will be stored (Default value)
    # If 0, the output and long output will not be stored (downtime and acknowledge will still be stored)
    # store_output      1

    # This option enables or disables storing sla long outputs.
    # If 1, the long output will be stored (Default value)
    # If 0, the long output will not be stored (output, downtime and acknowledge will still be stored)
    # store_long_output     1

    # This option will be used to filter which outputs and long outputs to store depending on the status of the sla.
    # Possible values are : OK, WARNING, CRITICAL, UNKNOWN
    # Seperator is : ,
    # Default value : empty (all output states are stored)
    # Example to only store OK and UNKNOWN outputs :  list_of_stored_output_status    OK,UNKNOWN
    # list_of_stored_output_status

    #======== Workers in the broker ========
    # This module will use workers in the broker, each worker will manage a shard of all hosts/checks.
    # This parameter is used by the broker to set the number of workers. Each worker will use one CPU, which will balance the sla processing load among CPUs.
    # default: 1
    broker_module_nb_workers     1

    #======== INTERNAL options =========
    #INTERNAL : DO NOT EDIT FOLLOWING PARAMETER 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
    # == max number of sla remove each daily_clean_pause_time. Use if nb_stored_days is not -1. ==
    #daily_clean_batch_size	10000
    # == delay between 2 sla clean. Use if nb_stored_days is not -1. (in second) ==
    #daily_clean_pause_time	2

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

}

define module{
...
...
...
    #======== 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

    # Which database is used to store sla data
    database             shinken


...
...
...
}

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

...
...
}