Broker Definition


The Broker daemon provides access to Shinken internal data. Its role is to get data from schedulers (like status and logs) and manage them. The management is done by modules. Many different modules exists : export to graphite, export to syslog, export into ndo database (MySQL and Oracle backend), service-perfdata export, couchdb export and more. To configure modules, consult the broker module definitions.

The Broker definition is optional.

Definition Format

Variables in red are required, while those in black are optional. However, you need to supply at least one optional variable in each definition for it to be of much use.

define broker{  
broker_name broker_name
address dns name of ip address
port port
spare //[0/1]//
realm realm name
manage_sub_realms [0,1]
modules modules

Example Definition:

define broker{
     broker_name        broker-1
     address            node1.mydomain
     port               7772
     spare              0
     realm              All
     ## Optional
     manage_arbiters     1
     manage_sub_realms   1
     timeout             3   ; Ping timeout
     data_timeout        120 ; Data send timeout
     max_check_attempts  3   ; If ping fails N or more, then the node is dead
     check_interval      60  ; Ping node every minutes               manage_sub_realms  1
     modules             Livestatus,Simple-log,WebUI

Variable Descriptions


This variable is used to identify the short name of the broker which the data is associated with.


This directive is used to define the adress from where the main arbier can reach this broker. This can be a DNS name or a IP adress.


This directive is used to define the TCP port used bu the daemon. The default value is 7772.


This variable is used to define if the broker must be managed as a spare one (will take the conf only if a master failed). The default value is 0 (master).


This variable is used to define the realm where the broker will be put. If none is selected, it will be assigned to the default one.


Take data from Arbiter. There should be only one broker for the arbiter.


This variable is used to define if the broker will take jobs from scheduler from the sub-realms of it’s realm. The default value is 1.


This variable is used to define all modules that the broker will load. The main goal ofthe Broker is to give status to theses modules.

Read the Docs v: documentation
On Read the Docs
Project Home

Free document hosting provided by Read the Docs.