Page History

#===============================================================================
# BROKER
#===============================================================================
# Description: The brokerBroker 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 = is a spare, 0 = is not a spare
    spare              # 1 = is a  spare, 0

 = is not #a spare_daemon:
 name of the daemonspare that will take this daemon job if it dies
    # IMPORTANT:
    #   * a spare_daemon can only be the spare of 1 (and only one) master daemon
    #   * a spare_daemon cannot have a spare_daemon0

    # spare_daemon: name of the daemon that will take this daemon job if it dies
    # IMPORTANT:
  * the spare# must have modules* witha thespare_daemon samecan module_typeonly asbe the master
spare of 1  # Example: spare_daemon    (and only one) master daemon
    #   * a  broker-spare
_daemon cannot have a spare_daemon

    #======== Daemon connection timeout and down state limit =========   * the spare must have modules with the same module_type as the master
    # timeout: how many seconds to consider a node don't answer    - depending of the value of the broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
    timeout # Example: spare_daemon              broker-spare
    3spare_daemon

    # data_timeout: how many second to consider a configuration transfert to be failed
    # because the network brandwith is too small.
    data_timeout              1201 = (default) the spare defined with spare_daemon must have the same module_type as this master
    # 0 = the spare module_type are not checked
    # broker__manage_spare__spare_must_have_the_same_list_of_module_type     1


    # max_check_attempts: how many fail check to consider this daemon as DEAD
    max_check_attempts        3

    # Check this daemon every X seconds
    check_interval======== Daemon connection timeout and down state limit =========
    # timeout: how many seconds to consider a node don't answer
    timeout                   60

3

    #======== Modules data_timeout: how many second to enable for this daemon =========consider a configuration transfert to be failed
    # Available:
because the network brandwith # - Simple-log is too small.
    data_timeout       : save all logs into a common file120

    # - WebUI         max_check_attempts: how many fail check to consider this daemon as DEAD
    max_check_attempts      : visualisation interface3

    # -Check Graphite-Perfdatathis daemon every   : save all metrics into a graphite database
    # - slaX seconds
    check_interval            60



    #======== Modules to enable for this  : save sla into a databasedaemon =========
    # Available:
    # - LivestatusSimple-log            : TCPsave APIall tologs queryinto elementa state, used by nagios external tools like NagVis or Thruk
common file
    # - WebUI     modules            : visualisation interface
    # Simple-log, WebUI, Graphite-Perfdata, sla, event-manager-writer
   : 

save all metrics  #======== Realm and architecture settings =========into a graphite database
    # Realm- tosla set this daemon into
    realm           : save sla into a database
    All

# - Livestatus  # 1 = take data from the daemon realm and its: subTCP realms
API to query element #state, 0used =by takenagios dataexternal onlytools fromlike theNagVis daemonor realmThruk
    modules  manage_sub_realms         1


     # In NATted environmentsSimple-log, you declare each satellite ip[:port] as seen byWebUI, Graphite-Perfdata, sla, event-manager-writer
    

    # *this* broker (if port not set, the port declared by satellite itself
    # is used)======== Realm and architecture settings =========
    # Realm to set this daemon into
    #satellitemaprealm    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) All

    # Note:1 as= compressiontake isdata automatic,from thisthe isdaemon a higher limit, realm and inits realsub case therealms
    # 0 = take data only from packetsthe will be lower than this valuedaemon realm
    # broksmanage_packetsub_sizerealms 1024


    #======== Memory protection =========       1


    # AreIn theNATted daemonenvironments, moduleyou processdeclare andeach worker process are waiting for enoughsatellite ip[:port] as seen by
    # memory to be available before being launch. Default: 1 (enabled)*this* Broker (if port not set, the port declared by satellite itself
    broker__manage_brok__enable_sub_processes_memory_usage_protection   1

# is used)
    ##satellitemap The sub process memory usage protection can have a system reserved memory
    # that won't be used by theses sub process when launched 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)
    # By defaultNote: 0as (nocompression reserved memory)
    # Example: 10  (means 10% of the total memory is reserved for the system)
    broker__manage_brok__sub_process_memory_usage_system_reserved_memory    0

is automatic, this is a higher limit, and in real case the
    #       packets will be lower than this value
    # If a sub process cannot be started because of the protection, how many secondsbroks_packet_size 1024


    #======== Memory protection =========
    # itAre the willdaemon bemodule retryprocess and worker waitprocess thatare thewaiting systemfor memoryenough
 is freed until it# failmemory to start
be available before being # By defaultlaunch. Default: 51 (secondsenabled)
    broker__manage_brok__enable_sub_processes_memory_usage_protection_max_retry_time   5
1

    #======== Brok pusher worker ========= The sub process memory usage protection can have a system reserved memory
    # The broker spawn broks pusherthat won't be used by theses sub process when launched
   to push# toBy externaldefault: modules0 (likeno reserved WebUImemory)
    # Example: 10  (means 10% of the brokertotal memory willis lookreserved atfor thisthe workersystem)
 execution time, and will kill if it timeout broker__manage_brok__sub_process_memory_usage_system_reserved_memory    0

    # TheIf brokera willsub computeprocess thecannot averagebe executionstarted timebecause of the protection, previoushow workersmany toseconds
    # decideit aboutwill howbe manyretry timeand thiswait workerthat willthe takesystem basedmemory on:
is freed until it #fail number of broks to send / past average send speed (broks/sto start
    # By default: 5 (seconds)
    # If this time is reach, it means that the pusher process is killed
broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time   5


    #======== Brok pusher worker =========
    # ForThe smallBroker amount ofspawn broks topusher send,sub itprocess shouldto leadpush to ridicuslyexternal smallmodules allowed execution time(like WebUI)
    # and the facBroker towill spawnlook the sub process can be higher than this value, so we are using a minimal
    # executionat this worker execution time, and will kill if it timeout
    # Default:The 5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeout     Broker will compute the average execution time of previous workers to
    # decide 5

about how many time #this worker Inwill ordertake tobased manageon:
 the fact that the# servernumber canof slowbroks downto duringsend this/ send,past youaverage cansend setup aspeed (broks/s)
    # ratioIf this thattime willis bereach, usedit tomeans increasethat the allowed timeout by multiply it
    # Default: 5
    broker__manage_brok__sub_process_broks_pusher_security_ratio                  5

    # At the broker start without stats, this valud will be used for thepusher process is killed

    # For small amount of broks to send, it should lead to ridicusly small allowed execution time
    # and the fac to spawn the sub process can be higher than this value, so we are using a minimal
    # execution timeout
    # Default: 2405 (secondssecond)
    broker__manage_brok__sub_process_broks_pusher_maxmin_execution_timeout           2405

    # If a sub process reach a timeout, it will be killed and relaunched. After max retry,
    # the attached module will be restarted In order to manage the fact that the server can slow down during this send, you can setup a
    # ratio that will be used to increase the allowed timeout by multiply it
    # Default: 35
    broker__manage_brok__sub_process_broks_pusher_max_retry                       3


    #======== Brok getter in modules =========
security_ratio       # These parameters allow some internal tuning in broks management in modules5
 
    # TakeAt the broker lockstart aswithout soonstats, asthis readervalud threadwill hasbe someused broksfor tothe managetimeout
    # inDefault: order to attempt to reduce concurrent usage of CPU240 (seconds)
    # broker__manage_brok_module_sub_process_broks_getterpusher_max_earlyexecution_locktimeout                            1
 240

    # Take extra broks sets to manage if more than this parameter sets are waitingIf a sub process reach a timeout, it will be killed and relaunched. After max retry,
    # the 0 special value disable managing of late broks sets
    #attached module will be restarted
    # Default: 3
    broker__manage_brok__sub_moduleprocess_broks_getterpusher_late_sets_allowed                     10
 
    # When enabled with previous parameter, stop taking extra broks sets when we already have
max_retry                  # this parameter broks to manage3

    # broker__manage_brok_module_sub_process_broks_getterpusher_maxqueue_late_broks_managedbatch_size:
    #   * defines the maximum number of broks the "queue brok pusher"
    #     process will handle per send to external module ( like WebUI 200000
) .
    # After we have managed some broks, if more than broker__manage_brok_module_broks_getter_late_sets_allowed
    # broks sets are waiting, continue late sets managing   * Remaining broks will be handled in next send.
    #   * IMPORTANT: increase this value can lead to error on the socket
    # Default: 100000 (broks/batch)
    # broker__manage_brok_module_sub_process_broks_getterpusher_loopqueue_onbatch_late_brokssize                    0100000


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

}