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

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

    #======== Daemon name and address ========= Port (HTTP/HTTPS) exposed by this daemon
    # Daemon name. Must be unique
port                   broker_name   7772

    # 0 = use HTTP, 1 = use broker-master

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


    #======== Master addressor spare selection =========
    # 1 = is a spare, 0 = is not a  localhost
spare
    #spare Port (HTTP/HTTPS) exposed by this daemon
    port           0

    # spare_daemon: name of the daemon that 7772

will take this daemon #job 0if =it usedies
 HTTP, 1 = use# HTTPSIMPORTANT:
    use_ssl	#   * a spare_daemon can only be the spare of 1 (and only one) master  0

daemon
    #======== Master or spare selection =========   * a spare_daemon cannot have a spare_daemon
    # 1 = is* athe spare, 0must =have ismodules notwith athe spare
same module_type as the sparemaster
    #     - depending of the value of       0
the broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
    # Example: spare_daemon:  name of the daemon that will take this daemon job if it diesbroker-spare
    # IMPORTANT:spare_daemon

    # 1  * a= (default) the spare defined with spare_daemon canmust onlyhave be the sparesame of 1 (and only one) master daemonmodule_type as this master
    # 0 = *the aspare spare_daemon cannot have a spare_daemon
module_type are not checked
    # broker__manage_spare__spare_must_have_the_same_list_of_module_type    # 1


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

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


    #======== Daemon connection timeout and down state limit =========
    # timeout: how many seconds to consider a node don't answer
    timeout        data_timeout: how many second to consider a configuration transfert to be failed
    # because the network brandwith is too small.
    data_timeout              120

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



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

WebUI    # max_check_attempts: how many fail check to consider this daemon as DEAD
  :  max_check_attemptsvisualisation interface
    # - Graphite-Perfdata  3

   : #save Checkall thismetrics daemoninto everya Xgraphite secondsdatabase
    check_interval# -    sla       60



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

 - Graphite-Perfdata  #======== Realm and :architecture save all metrics into a graphite database
    # - slasettings =========
    # Realm to set this daemon into
    realm               : save sla into a databaseAll

    # -1 Livestatus= take data from the daemon realm and its sub realms
  : TCP API# to0 query= elementtake state,data usedonly byfrom nagiosthe externaldaemon toolsrealm
 like NagVis or Thruk
 manage_sub_realms    modules    1


    # In NATted environments, you declare each satellite ip[:port] as  Simple-log, WebUI, Graphite-Perfdata, sla, event-manager-writer
    

    #======== Realm and architecture settings =========seen by
    # *this* Broker (if port not set, the port declared by satellite itself
    # Realmis toused)
 set this daemon into
#satellitemap    realm 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 All
kB)
    # 1 = take data from the daemon realm and its sub realmsNote: as compression is automatic, this is a higher limit, and in real case the
    # 0 = take data only from thepackets daemonwill realm
be lower than  manage_sub_realmsthis value
    #    1broks_packet_size 1024


    # In NATted environments, you declare each 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======== Memory protection =========
    # Are the daemon module process and worker process are waiting for enough
    # memory to be available before being launch. Default: 1 (enabled)
    broker__manage_brok__enable_sub_processes_memory_usage_protection   1

    # ExchangeThe sub betweenprocess brokersmemory <-usage schedulersprotection can have a system reserved memory
    # that won't be limitedused by theses packetsub sizeprocess (inwhen kB)launched
    # NoteBy default: 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 =========0 (no 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

    # If a sub process cannot be started because of the protection, how many seconds
    # Areit thewill daemonbe module processretry and workerwait processthat arethe waitingsystem formemory enough
is  freed until #it memoryfail to bestart
  available before being# launch.By Defaultdefault: 15 (enabledseconds)
    broker__manage_brok__enable_sub_processes_memory_usage_protection_max_retry_time   15


    # The sub process memory usage protection can have a system reserved memory======== Brok pusher worker =========
    # thatThe won'tBroker bespawn usedbroks by thesespusher sub process whento launched
push to external  # By default: 0 (no reserved memorymodules (like WebUI)
    # Example: 10  (means 10% of the totalBroker memorywill islook reservedat for the system)
    broker__manage_brok__sub_process_memory_usage_system_reserved_memory    0
this worker execution time, and will kill if it timeout
    # IfThe aBroker subwill processcompute cannotthe beaverage startedexecution becausetime of previous theworkers protection,to
 how many seconds
 # decide about #how itmany willtime bethis retryworker andwill waittake thatbased theon:
 system memory is freed# untilnumber itof failbroks to start
send / past average #send Byspeed default: 5 (seconds(broks/s)
    #  broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time   5


    #======== 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 itIf this time is reach, it means that the pusher 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
    # TheDefault: broker will compute the average execution time of previous workers to
5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeout         # decide about5

 how many time this# workerIn willorder taketo basedmanage on:
the fact that the #server numbercan ofslow broksdown toduring send / past average send speed (broks/s)this send, you can setup a
    # Ifratio thisthat timewill isbe reach,used itto meansincrease thatthe theallowed pushertimeout processby ismultiply killed
it
    # 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 Default: 5
    broker__manage_brok__sub_process_broks_pusher_security_ratio                  5

    # At the broker start without stats, this valud will be used for the timeout
    # Default: 5240 (secondseconds)
    broker__manage_brok__sub_process_broks_pusher_minmax_execution_timeout           5240

    # InIf a ordersub toprocess managereach thea facttimeout, thatit thewill serverbe cankilled slowand downrelaunched. duringAfter thismax send, you can setup aretry,
    # the ratioattached thatmodule will be used to increase the allowed timeout by multiply 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

}