Page History

#========================================================================================
# BROKER
#=====================================================================================
# Description: The broker is responsible for:
# - Exporting centralized logs of all Shinken daemon processes
# - Exporting status data
# - Exporting performance data
# - Exposing Shinken APIs:
#   - Status data
#   - Performance data
#   - Command interface
#===========================================
# Description: The Broker is responsible for:
# - Exporting centralized logs of all Shinken daemon processes
# - Exporting status data
# - Exporting performance data
# - Exposing Shinken APIs:
#   - Status data
#   - Performance data
#   - Command interface
#===============================================================================

define broker {

    #======== Daemon name and address =========
    # Daemon name. Must be unique
    broker_name               broker-master

    # IP/fqdn of this daemon (note: you MUST change it by the real ip/fqdn of this server)
    address                   localhost

    # Port (HTTP/HTTPS) exposed by this daemon
    port                      7772

    # 0 = use HTTP, 1 = use HTTPS
    use_ssl	                  0


    #======== Master or spare selection =========
    # 1 ====================

define broker { is a spare, 0 = is not a spare
    spare                     0

    #======== Daemon name and address =========
    # Daemon name. Must be unique spare_daemon: name of the daemon that will take this daemon job if it dies
    # IMPORTANT:
    broker_name#   * a spare_daemon can only be the spare of 1 (and only one) broker-master daemon

    #  IP/fqdn of* thisa spare_daemon (note: you MUST change it by the real ip/fqdn of this server)
    address          cannot have a spare_daemon
    #   * the spare must have modules with the same module_type as the master
    #     - depending of the localhost

value of the  # Port (HTTP/HTTPS) exposed by this daemon
broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
    # Example: spare_daemon    port          broker-spare
    spare_daemon

    # 1 =  7772

    # 0 = use HTTP, 1 = use HTTPS(default) the spare defined with spare_daemon must have the same module_type as this master
    use_ssl	# 0 = the spare module_type are not checked
    # broker__manage_spare__spare_must_have_the_same_list_of_module_type     01


    #======== Master or spare selectionDaemon connection timeout and down state limit =========
    # 1timeout: =how is a spare, 0 = is notmany seconds to consider a spare
node don't answer
  spare  timeout                   03

    # sparedata_daemontimeout: namehow ofmany thesecond daemonto thatconsider willa takeconfiguration thistransfert daemonto job if it diesbe failed
    # because IMPORTANT:
the network brandwith is #too small.
  * a sparedata_daemon cantimeout only be the spare of 1 (and only one) master daemon
   120

 #   * a spare_daemon cannot have a spare_daemon
    #   * the spare must have modules with the same module_type as the master# max_check_attempts: how many fail check to consider this daemon as DEAD
    max_check_attempts        3

    # Example: spare_daemon  Check this daemon every X seconds
    check_interval        broker-spare
    spare_daemon60



    #======== DaemonModules connectionto timeoutenable andfor downthis state limitdaemon =========
    # timeoutAvailable:
 how many seconds to# consider a node don't answer
    timeout- Simple-log            : save all logs into a common 3
file
    # data_timeout: how many second to consider a configuration transfert to be failed
- WebUI              # because the network: brandwith is too small.visualisation interface
    data_timeout# - Graphite-Perfdata     : save all metrics into a graphite 120
database
    # max_check_attempts: how many fail check to consider this daemon as DEAD
 - sla            max_check_attempts       : 3

save sla into a #database
 Check this daemon every# X- seconds
Livestatus    check_interval        : TCP API to 60



query element state,  #======== Modules to enable for this daemon =========used by nagios external tools like NagVis or Thruk
    #modules  Available:
    # - Simple-log            : save all logs into a common fileSimple-log, WebUI, Graphite-Perfdata, sla, event-manager-writer
    

    # - WebUI   ======== Realm and architecture settings =========
    # Realm to set this daemon into
    :realm visualisation interface
    # - Graphite-Perfdata     : save all metrics into a graphite databaseAll

    # -1 sla= take data from the daemon realm and its sub realms
    # 0 = take data :only save slafrom intothe adaemon databaserealm
    # - Livestatusmanage_sub_realms        1


    # In NATted :environments, TCPyou APIdeclare toeach query element state, used by nagios external tools like NagVis or Thruk
    modules                   Simple-log, WebUI, Graphite-Perfdata, sla, event-manager-writer
    

    #======== Realm and architecture settings =========
    # Realm to set this daemon into
    realm                    All

    # 1 = take data from the daemon realm and its sub realms
    # 0 = take data only from the daemon realm
    manage_sub_realms        1

satellite ip[:port] as seen by
    # *this* Broker (if port not set, the port declared by satellite itself
    # is used)
    #satellitemap    scheduler-1=1.2.3.4:7768, poller-1=1.2.3.5:7771

    # Exchange between brokers <- schedulers can be limited by packet size (in kB)
    # Note: as compression is automatic, this is a higher limit, and in real case the
    #       packets will be lower than this value
    # broks_packet_size 1024


    #======== Memory protection =========
    # Are the daemon module process and worker process are waiting for enough
    # Inmemory NATtedto environments,be youavailable declarebefore eachbeing satellitelaunch. ip[Default:port] as seen by
 1 (enabled)
   # *this* broker (if port not set, the port declared by satellite itself
    # is used)
    #satellitemap    scheduler-1=1.2.3.4:7768, poller-1=1.2.3.5:7771

    # Exchange between brokers <- schedulers can be limited by packet size (in kBbroker__manage_brok__enable_sub_processes_memory_usage_protection   1

    # The sub process memory usage protection can have a system reserved memory
    # that won't be used by theses sub process when launched
    # By default: 0 (no reserved memory)
    # NoteExample: as10 compression is(means automatic,10% thisof isthe atotal highermemory limit,is andreserved in realfor case the
    # system)
    broker__manage_brok__sub_process_memory_usage_system_reserved_memory   packets will0

 be lower than this# value
If a sub process # broks_packet_size 1024


    #======== Memory protection =========cannot be started because of the protection, how many seconds
    # Areit thewill daemonbe moduleretry process and workerwait processthat arethe waitingsystem formemory enough
is freed until it #fail memoryto tostart
 be available before being# launch.By Defaultdefault: 15 (enabledseconds)
    broker__manage_brok__enable_sub_processes_memory_usage_protection_memory_usage_protection_max_retry_time   15


    # The sub process memory usage protection can have a system reserved memory
    # that won't be used by theses sub process when launched
    # By default: 0 (no reserved memory)======== Brok pusher worker =========
    # The Broker spawn broks pusher sub process to push to external modules (like WebUI)
    # the Broker will look at this worker execution time, and will kill if it timeout
    # Example: 10  (means 10% of the total memory is reserved for the system)
    broker__manage_brok__sub_process_memory_usage_system_reserved_memory    0

The Broker will compute the average execution time of previous workers to
    # decide about how many time this worker will take based on:
    # Ifnumber aof subbroks processto cannotsend be/ startedpast becauseaverage ofsend the protection, how many secondsspeed (broks/s)
    # itIf this willtime beis retryreach, andit waitmeans that the systempusher memoryprocess is freed until it fail to startkilled

    # By default: 5 (seconds)
    broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time   5


    #======== Brok pusher worker =========For small amount of broks to send, it should lead to ridicusly small allowed execution time
    # and Thethe fac brokerto spawn broksthe pusher sub process to push to external modules (like WebUI)
    # the broker will look at this worker execution time, and will kill if it timeout
    # The broker will compute the average execution time of previous workers tocan be higher than this value, so we are using a minimal
    # execution timeout
    # Default: 5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeout           5

    # decideIn aboutorder howto manymanage timethe thisfact workerthat willthe takeserver basedcan on:
slow down   # number of broks toduring this send, /you pastcan average send speed (broks/s)setup a
    # Ifratio thisthat timewill isbe reach,used itto meansincrease thatthe theallowed pushertimeout processby ismultiply killed
it
    # Default: For5
 small amount of broks to send, it should lead to ridicusly small allowed execution time
 broker__manage_brok__sub_process_broks_pusher_security_ratio          # and the fac to spawn the sub process5

 can be higher than# thisAt value,the sobroker westart arewithout usingstats, athis minimal
valud will be used #for executionthe timeout
    # Default: 5240 (secondseconds)
    broker__manage_brok__sub_process_broks_pusher_minmax_execution_timeout           5

    # In order to manage the fact240

 that the server can# slowIf downa duringsub thisprocess send,reach youa cantimeout, setupit a
will be killed and #relaunched. ratioAfter thatmax willretry,
 be used to increase# the allowedattached timeoutmodule bywill multiplybe itrestarted
    # Default: 53
    broker__manage_brok__sub_process_broks_pusher_security_ratiomax_retry                       53

    # At the broker start without stats, this valud will be used for the timeout
    # Default: 240 (seconds)
    broker__manage_brok__sub_process_broks_pusher_max_execution_timeout           240
 broker__manage_brok__sub_process_broks_pusher_queue_batch_size:
    #   * defines the maximum number of broks the "queue brok pusher"
    #     process will handle per send to external module ( like WebUI ) .
    #  If a sub process reach a timeout, it will be killed and relaunched. After max retry,
    # the attached module will be restarted * Remaining broks will be handled in next send.
    #   * IMPORTANT: increase this value can lead to error on the socket
    # Default: 3 100000 (broks/batch)
    # broker__manage_brok__sub_process_broks_pusher_maxqueue_batch_retrysize                       3100000


     # #======== Enable or not this daemon =========
    # 1 = is enabled, 0 = is disabled
    enabled                  1

}