Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmlfalse
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Rôle

Le démon Broker exporte et gère les données du Scheduler ( les objets Broks ).

  • Sa gestion ne peut se faire qu'à travers des modules.
  • Plusieurs modules de gestion peuvent être activés en même temps. 

Exemples de modules du Broker :

  • Module pour exporter les données de métrologie: Graphite-Perfdata
  • Module pour l'API Livedata
  • Module pour l'affichage de l'interface de visualisation : WebUI

Données : les Broks

Le Broker reçoit toutes les données des Schedulers. Ce sont les objets Broks.

Info
titleLes Broks

Les Broks sont des conteneurs de données échangées entre les Schedulers et les Brokers. Il y a plusieurs types de Broks :

  • Des évènements ( comme un Scheduler qui vient de démarrer ).
  • La configuration des éléments supervisés ( hôtes, checks, période de temps, utilisateurs ).
  • L'état des hôtes, clusters et checks après chaque vérification.


Le rôle du démon Broker est de donner ces données ( Broks ) à tous ses modules.


Panel

Image RemovedImage Added

Données de métrologie

Les données de métrologie sont sauvegardées sur le serveur du Broker dans l'application graphite.

Cette application écoute le port 2003, et cette connexion se fait sans authentification.

Cette application doit donc écouter exclusivement sur l'interface réseau locale ( loopback ) du serveur du Broker. 

Logique interne du Broker

Panel

Image RemovedImage Added

Résumé des connexions du Broker

SourceDestinationPortProtocoleNote
BrokerScheduler7768HTTP/HTTPS

Description des variables

Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautCommentaireDescription
No Format
broker_name
Texte__

Cette variable est utilisée pour identifier le nom réduit du Broker auquel les données sont associées.

No Format
address
URLlocalhost

Définit l'adresse permettant de joindre ce Broker.

Par défaut "localhost", changez-le par un nom DNS ou une adresse IP.

No Format
port
Entier__7772

Port TCP utilisé par le démon.

No Format
use_ssl
Booléen__0

Définit si le Broker doit être contacté en HTTPS ou HTTP.

Valeurs possibles:

  • 1 ( HTTPS )
  • 0 ( HTTP )


No Format
spare
Booléen__0 ( maître )

Définit si le Broker peut être géré comme un spare ( prendra uniquement la configuration si le maître échoue ).

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
spare_daemon
Texte____

Nom du démon spare ( c.a.d broker_name, à ne pas confondre avec son nom DNS ou adresse IP ) qui sera utilisé pour reprendre le travail de ce démon s'il vient à ne plus être disponible.

No Format
broker__manage_spare__spare_must_have_the_same_list_of_module_type
Booléen__1

Définit si la configuration des modules du spare défini par spare_daemon sera vérifiée pour voir si elle corresponds bien à celle du maitre.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
timeout
EntierSeconde3

Définit le temps en secondes avant que l'Arbiter ne considère ce démon comme à l'arrêt. Si ce démon est joignable en HTTPS ( use_ssl à 1 ) avec une latence élevée, nous vous conseillons Shinken conseille alors d'augmenter cette la valeur de timeout ( l'Arbiter aura besoin de plus d'allers/retours pour le contacter ).

No Format
data_timeout
EntierSeconde120

Temps avant de considérer un transfert de configuration ou de données comme échoué.

No Format
max_check_attempts
Entier__3

Si le ping permettant de détecter la disponibilité réseau du nœud est en échec N fois ou plus, alors le nœud est considéré comme mort .

No Format
check_interval
EntierSeconde60

Intervalle de Ping.

No Format
modules
Texte____

Définit les modules chargés par le Broker.

No Format
realm
Texte____

Définit le royaume où le Broker doit être.

Si aucun n'est sélectionné, celui par défaut lui sera assigné.

No Format
manage_sub_realms
Booléen__1

Définit si le Broker prendra des tâches des Schedulers des sous-royaumes.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
manage_arbiters
Booléen__1

Prends les données de l'Arbiter. Il ne devrait y avoir qu'un seul Broker pour l'Arbiter.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
satellitemap
Texte

__

__

Cette variable est utilisée dans le cas de royaume situé derrière un réseau NATé.

  • Elle est de la forme d'une liste séparée par des "," de valeur nom-démon=address:port
  • Les démons ainsi listé seront contacté avec le couple address:port du paramètre au lieu de leur adresse dans leur .cfg. *

Ceci permet ainsi à des démon derrière un réseau NAT d'échanger sur leur adresse locale au lieu de devoir ressortir sur leur adresse publique.

  • Exemple:  daemon1=192.168.0.1:7768,daemon2=192.168.0.1:7771
No Format
broks_packet_size
EntierKilo-octet204800

Si présentes, les demandes vers les Schedulers vont avoir comme limite haute de taille de paquet cette valeur ( en Ko ).

Par défaut les envois sont illimités.

No Format
broker__manage_brok__enable_sub_processes_memory_usage_protection
Booléen__1

Définit si le Broker va vérifier qu'il y a assez de RAM disponibles sur le système avant de lancer ses processus workers qui poussent les broks vers les modules externes ( comme WebUI ).

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
broker__manage_brok__sub_process_memory_usage_system_reserved_memory
EntierPourcentage0

Dans le cas de la protection de mémoire, on peut réserver un pourcentage de RAM pour le système qui ne sera pas considérée comme disponible par le démon.

No Format
broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time
EntierSeconde5

Dans le cas de la protection mémoire, pendant combien de temps le Broker va attendre avant de considérer qu'il n'a pas assez de mémoire, ce qui aura comme conséquence de tuer le module externe concerné.

No Format
broker__manage_brok__sub_process_broks_pusher_min_execution_timeout
EntierSeconde5

Temps que le Broker va laisser aux workers qui poussent les broks vers les modules externes pour s'exécuter.

No Format
broker__manage_brok__sub_process_broks_pusher_security_ratio
Entier__5

Le Broker va estimer le temps d'exécution des workers qui poussent les broks en se basant sur leur moyenne passée, et va appliquer ce ratio multiplicateur comme timeout d'exécution.

No Format
broker__manage_brok__sub_process_broks_pusher_max_execution_timeout
EntierSeconde240

Temps que le Broker va laisser aux workers qui poussent les broks vers les modules externes pour s'exécuter.

No Format
broker__manage_brok__sub_process_broks_pusher_max_retry
Entier__3

Nombre de tentatives où le Broker va relancer les workers qui poussent les broks avant d’arrêter et tuer le module lié.

No Format
broker__manage_brok__sub_process_broks_pusher_queue_batch_size
Entier__100000

Taille maximum en nombres de Broks que peuvent faire les workers qui poussent les broks aux modules externes ( comme WebUI ).

Attention, trop augmenter cette limite peux poser des problèmes d'envoi trop importants pour la socket de communication.

No Format
enabled
Booléen__1

Définit si le Broker est activé ou non.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )

Définition - exemple

broker__manage_brok__oversized_data_warning_threshold__serialization_time
EntierMillisecondes100

Délai en millisecondes passées à la sérialisation d'un Brok lors de l'envoi au module ( et ses workers ). Passé ce délai sera affiché dans les logs du Broker en WARNING deux messages contenant :

  • le temps passé à le sérialiser et la taille de ses données variables.
  • le temps passé à le sérialiser et le nombre de ses données variables.

( voir la page Broker - Les logs communs des modules du Broker ).

No Format
broker__manage_brok__oversized_data_error_threshold__serialization_time
EntierMillisecondes500

Délai en millisecondes passées à la sérialisation d'un Brok lors de l'envoi au module ( et ses workers ). Passé ce délai sera affiché dans les logs du Broker en ERROR deux messages contenant :

  • le temps passé à le sérialiser et la taille de ses données variables.
  • le temps passé à le sérialiser et le nombre de ses données variables.

( voir la page Broker - Les logs communs des modules du Broker ).


Warning

La valeur ne peut pas être strictement inférieur au seuil d'attention.

No Format
enabled
Booléen__1

Définit si le Broker est activé ou non.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )

Définition - exemple

Dans le répertoire /etc/shinken/brokers/, voici un exemple de définition qui permet la définition du Broker ( à placer dans un fichier CFG )  :

(warning) Il est conseillé d'éditer les fichiers .cfg avec l'encodage utf-8

Code Block
languagejs
themeConfluence
#=

Dans le répertoire /etc/shinken/brokers/, voici un exemple de définition qui permet la définition du Broker ( à placer dans un fichier CFG )  :

(warning) Il est conseillé d'éditer les fichiers .cfg avec l'encodage utf-8

Code Block
languagejs
themeConfluence
#===============================================================================
# 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
#==================================================================
# 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

    # Port (HTTP/HTTPS) exposed by this daemon
    port 
# 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 {

# 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-broker-060340145ade11e5b703080027f08538
    _SE_UUID_HASH       8e00136f9e61061e07ca0f4a63509b68
# End of Shinken Enterprise part

    #======== Daemon name and  7772
address =========
    # 0Daemon =name. useMust HTTP, 1 = use HTTPSbe unique
    usebroker_ssl	name                  0broker-master


    #======== Master or spare selection =========
    # 1 = is a spare, 0 = is not a spare
    spare 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 0daemon

    # spare_daemon: name of the daemon that will take this daemon job if it dies
port                     # IMPORTANT:7772

    # 0 = *use a spare_daemon can only be the spare of 1 (and only one) master daemon
HTTP, 1 = use HTTPS
    use_ssl	         #   * a spare_daemon cannot have a spare_daemon
    #   * the spare must have modules with the same module_type as the master
    #0


    #======== Master or spare selection =========
    # 1 = is a spare, 0 = is not a spare
    spare          - depending of the value of the broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter     0

    # Example: spare_daemon: name of the daemon that will take this daemon job if it dies
 broker-spare
    spare_daemon
# IMPORTANT:
    # 1 = (default) the spare defined with * a spare_daemon mustcan haveonly be the spare of same module_type as this master1 (and only one) master daemon
    #  0 =* thea spare_daemon module_typecannot arehave nota checkedspare_daemon
    # broker__manage_spare__spare_must_have_the_same_list_of_   * the spare must have modules with the same module_type as the master
  1


  #     #======== Daemon connection timeout and down state limit =========- depending of the value of the broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
    # timeoutExample: howspare_daemon many seconds to consider    a node don't answer
   broker-spare
 timeout   spare_daemon

    # 1 = (default) the spare defined with spare_daemon must have the 3

    # data_timeout: how many second to consider a configuration transfer to be failedsame module_type as this master
    # 0 = the spare module_type are not checked
    # because the network bandwidth is too small.broker__manage_spare__spare_must_have_the_same_list_of_module_type     1


    data_timeout        #======== Daemon connection timeout and down state limit =========
    # timeout: 120

how many seconds  # max_check_attempts: how many fail check to consider this daemon as DEAD
to consider a node don't answer
    timeout           max_check_attempts        3

    # Check this daemon every X seconds
    check_interval data_timeout: how many second to consider a configuration transfer to be failed
    # because the network bandwidth is too 60

small.
    #======== Modules to enable for this daemon =========
data_timeout             # Available:120

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

    # :Check Visualisationthis interface
daemon every X seconds
 # - Graphite-Perfdata check_interval             : Save all metrics into a graphite database60


    #======== Modules to enable for this daemon =========
    # -Available:
 sla   # - WebUI                       : Save sla into: aVisualisation databaseinterface
    # - LivestatusGraphite-Perfdata              : Save all metrics into a graphite :database
 TCP API to query# element- state,sla used by nagios external tools like NagVis or Thruk
    # - broker-module-livedata         : REST API to query: allSave monitoredsla elementinto data (host, cluster or check)a database
    # - event-manager-writerLivestatus           : Save events for events manager (do not forget to activate: the module in your webui to see data)TCP API to query element state, used by nagios external tools like NagVis or Thruk
    # - Simplebroker-module-loglivedata         : REST API to query all monitored element data (host, cluster or :check)
 Save all logs into# a common file, Use this module only if you need to have all the check results in one file.
    # - broker--module-report-builder  : External module used by webui--module-report-handler to generate reports
    modules- event-manager-writer           : Save events for events manager (do not forget to activate the module in your webui to see data)
    # - Simple-log                     : Save all logs WebUI, Graphite-Perfdata, sla, event-manager-writer


    #======== Realm and architecture settings =========
    # Realm to set this daemon into
    realm           into a common file, Use this module only if you need to have all the check results in one file.
    # - broker--module-report-builder  : External module used by webui--module-report-handler to generate reports
    modules         All

    # 1 = take data from the daemon realm and its sub realmsWebUI, Graphite-Perfdata, sla, event-manager-writer
    

    # 0 ======== takeRealm dataand onlyarchitecture from the daemon realmsettings =========
    manage_sub_realms# Realm to set this daemon into
  1


  realm  # In NATted environments, you declare each satellite ip[:port] as seen by
    # *this* Broker (ifAll

 port not set, the# port1 declared= bytake satellitedata itself
from the daemon realm #and is used)its sub realms
    #satellitemap# 0 =  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)take data only from the daemon realm
    manage_sub_realms        1

    # Note:In as compression is automaticNATted environments, thisyou isdeclare aeach higher limit, and in real case thesatellite ip[:port] as seen by
    # *this* daemon (if port not set, packetsthe willport bedeclared lowerby thansatellite this valueitself
    # broks_packet_size 1024


    #======== Memory protection =========is used)
    #satellitemap    scheduler-1=1.2.3.4:7768, scheduler-2=1.2.3.5:7771

    # AreExchange between thebrokers daemon<- moduleschedulers processcan andbe workerlimited processby arepacket waitingsize for(in enoughkB)
    # memoryNote: toas becompression availableis beforeautomatic, beingthis launch.is Default:a 1 (enabled)
    broker__manage_brok__enable_sub_processes_memory_usage_protection   1

higher limit, and in real case the
    #  The sub process memory usage protectionpackets canwill havebe alower systemthan reservedthis memoryvalue
    # that won't be used by theses sub process when launchedbroks_packet_size 1024


    #======== Memory protection =========
    # ByAre default:the 0daemon (nomodule reservedprocess memory)
and worker process are #waiting Example:for 10enough
  (means 10% of# the total memory is reserved for the systemmemory to be available before being launch. Default: 1 (enabled)
    broker__manage_brok__enable_sub_processprocesses_memory_usage_system_reserved_memoryprotection    01

    # If aThe sub process cannotmemory beusage startedprotection becausecan ofhave thea protection,system howreserved many secondsmemory
    # itthat willwon't be retryused andby waittheses thatsub the system memory is freed until it fail to startprocess when launched
    # By default: 0 (no reserved memory)
    # ByExample: default:10 5 (secondsmeans 10% of the total memory is reserved for the system)
    broker__manage_brok__sub_processesprocess_memory_usage_protectionsystem_max_retry_timereserved_memory    50


    #======== 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 If a sub process cannot be started because of the protection, how many seconds
    # it will be retry and wait that the system memory is freed until it fail to start
    # TheBy Brokerdefault: will compute the average execution time of previous workers to5 (seconds)
    broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time   5


    # decide about how many time this worker will take based on:======== Brok pusher worker =========
    # numberThe broker ofspawn broks topusher sub sendprocess /to pastpush averageto sendexternal speedmodules (broks/slike WebUI)
    # Ifthe broker will look at this timeworker isexecution reachtime, itand meanswill thatkill theif pusher process is killed

it timeout
    # ForThe broker smallwill amountcompute ofthe broksaverage toexecution send,time itof shouldprevious leadworkers to
 ridiculously small allowed execution# time
decide about how many #time andthis theworker facwill totake spawnbased theon:
 sub process can be# highernumber thanof this value, so we are using a minimalbroks to send / past average send speed (broks/s)
    # executionIf timeout
this time is reach, #it Default:means 5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeoutthat the pusher process is killed

    # For small amount of broks  5

to send, it should lead to ridiculously small allowed execution time
    # Inand the orderfac to managespawn the factsub thatprocess the server can slowbe downhigher duringthan this sendvalue, youso we canare setupusing a minimal
    # ratioexecution thattimeout
 will be used to# increaseDefault: the allowed timeout by multiply it
    # Default: 5
 5 (second)
    broker__manage_brok__sub_process_broks_pusher_securitymin_execution_ratiotimeout           5

    # In order 5

to manage the fact #that Atthe theserver Brokercan startslow withoutdown stats,during this validsend, willyou becan used for the timeoutsetup a
    # Default:ratio 240 (seconds)that will be used to increase the allowed timeout by multiply it
    # Default: 5
    broker__manage_brok__sub_process_broks_pusher_max_execution_timeoutsecurity_ratio                  2405

    # IfAt athe subbroker processstart reachwithout astats, timeout,this itvalid will be killedused andfor relaunched. After max retry,
    # the attached module will be restartedthe timeout
    # Default: 240 3(seconds)
    broker__manage_brok__sub_process_broks_pusher_max_retryexecution_timeout           240

    # If a sub process reach a  3



    #======== Enable or not this daemon =========timeout, it will be killed and relaunched. After max retry,
    # the attached module will be restarted
    # 1Default: =3
 is enabled, 0 = is disabled
 broker__manage_brok__sub_process_broks_pusher_max_retry      enabled                  1

}

3

    # 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 ) .
    #   * 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__sub_process_broks_pusher_queue_batch_size      100000

    # Broks whose serialization time exceeds this threshold will generate a warning
    # Default: 100 (milliseconds)
    # broker__manage_brok__oversized_data_warning_threshold__serialization_time   100

    # Broks whose serialization time exceeds this threshold will generate an error
    # Default: 500 (milliseconds)
    # broker__manage_brok__oversized_data_error_threshold__serialization_time     500


    #======== VMWare / ESXi ==========
    # 1 (default) = if vmware get the ESXi CPU stats value, 0 = do not get value
    vmware__statistics_compute_enable     1


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

}
  
Excerpt
hiddentrue
Scroll Title
anchordata_for_check_sup_de_sup
title
NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
No Format
BROKER_PORT

l'Hôte

( Onglet Données )

---7772 7772

Configuration du port de communication avec le Broker.

Modèles définissant cette donnée : 

Note : Cette valeur remplacera la valeur $ARG1$ dans la commande