Versions Compared

Key

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

Table of Contents
maxLevel3
stylenone

Rôle

Le démon broker 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 centraliser les logs Shinken

:

Simple-log (flat file)

  • Module pour exporter les données de métrologie: Graphite-Perfdata
  • Module pour l'API Livestatus 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. Il garde également en mémoire les données des hôtes et des checks.

Enfin, il sauvegarde les résultats des checks dans une base mongodb (si possible, cette base doit être installée sur le même serveur que le broker).

Image Removed

Données de métrologie

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 Added

Données de métrologie

Les données de métrologie sont sauvegardées sur le serveur du broker 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 brokerBroker

Logique interne du Broker Broker

Panel
Image Removed

Image Added

Résumé des connexions du Broker

SourceDestinationPortProtocoleNote
BrokerScheduler7768HTTP/HTTPS
BrokerPoller7771HTTP/HTTPSBrokerReactionner7769HTTP/HTTPSBrokerReceiver7773HTTP/HTTPS
BrokerBroker (local)2003TCPinterface localhost uniquement

Description des variables


Description des variables

Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
broker_name
Texte__
PropriétéDéfautDescription

broker_name

N/A

Cette variable est utilisée pour identifier le

*

nom réduit

*

du Broker auquel les données sont associées.

No Format
address
N/A
URLlocalhost

Définit

Cette directive est utilisée pour définir

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
Cette directive est utilisée pour définir le port

Port TCP utilisé par le démon.

No Format
use_ssl
Booléen__0
Cette variable est utilisée pour définir

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

(*1*)

ou HTTP

(*0*).

.

Valeurs possibles:

  • 1 ( HTTPS )
  • 0
La valeur par défaut est *0*
  • ( HTTP )
.


No Format
spare
Booléen__0
Cette variable est utilisée pour définir
( maître )

Définit si le

broker

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

La valeur par défaut est *0* (maître).

Valeurs possibles:

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

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
Si cette option est désactivée (0), alors

Définit si la configuration des modules du spare défini par spare_daemon

ne

sera

pas

vérifiée pour voir si elle corresponds bien à celle du

master

maitre.

Valeurs possibles:

  • 1 ( Activé )
  • 0 ( Désactivé )
No Format
timeout
EntierSeconde3
Cette variable est utilisée pour définir

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
Cette variable est utilisée pour définir le temps en secondes

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 .

(par défaut, 3 tentatives)

No Format
check_interval
60
EntierSeconde60

Intervalle de Ping

toutes les N secondes

.

No Format
modules
N/A
Texte____

Définit

Cette variable est utilisée pour définir

les modules chargés par le

broker

Broker.

No Format
realm
N/A
Texte____

Définit

Cette variable est utilisée pour définir

le royaume où le

broker

Broker doit être.

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

No Format
manage_sub_realms
Booléen__1
Cette variable est utilisée pour définir

Définit si le

broker

Broker prendra des tâches des Schedulers des sous-royaumes.

manage_arbiters

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

Broker pour l'Arbiter.

Valeurs possibles:

  • 1 ( Activé )

satellitemap

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

__

__
N/A

Cette variable est utilisée

pour définir, pour des environnements NATés, les différents satellites comme vus depuis ce broker.

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

broks_packet_size

204800Si 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.

broker__manage_brok__enable_sub_processes_memory_usage_protection

1Si activé, 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)

broker__manage_brok__sub_process_memory_usage_system_reserved_memory

0Dans 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
broker__manage_brok__enable_sub_processes_memory_usage_protection
Booléen_
max
_
retry_time
5
1
Dans le cas de la protection mémoire, pendant combien de temps le broker va attendre (en secondes) avant de considérer

Définit si le Broker va vérifier qu'il

n'

y a

pas

assez de

mémoire, ce qui aura comme conséquence de tuer le module externe concerné.

broker__manage_brok__sub_process_broks_pusher_min_execution_timeout

5Temps (en seconde) que le broker va laisser aux workers qui poussent les broks vers les modules externes pour s'exécuter.

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_
broks
memory_usage_
pusher
system_
security_ratio5Le 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.
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_
process
processes_memory_
broks
usage_
pusher
protection_max_
execution_timeout240Temps (en secondes) que le broker va laisser aux workers qui poussent les broks vers les modules externes pour s'exécuter.
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_
max_retry3Nombre de tentatives où le broker va relancer les
execution_timeout
EntierSeconde5

Temps que le Broker va laisser aux workers qui poussent les broks

avant d’arrêter et tuer le module lié.

enabled

N/ACette variable est utilisée pour définir si le broker est activé ou non.

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

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
languagebash
#===============================================================================
# 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
#===============================================================================

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                     0

    # spare_daemon: name of the daemon 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_daemon
    #   * the spare must have modules with the same module_type as the master
    #     - depending of the value of the broker__manage_spare__spare_must_have_the_list_of_module_type parmeter
    # Example: spare_daemon              broker-spare
    spare_daemon

    # 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_list_of_module_type     1


    #======== Daemon connection timeout and down state limit =========
    # timeout: how many seconds to consider a node don't answer
    timeout                   3

    # data_timeout: how many second to consider a configuration transfert to be failed
    # because the network brandwith is too small.
    data_timeout================================================
# 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
#===============================================================================

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 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	              120

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


    #======== Master or spare selection =========
    # 1 = is a spare, 0 = is not a spare
    #spare Check this daemon every X seconds
    check_interval            600



    #======== Modules to enable for spare_daemon: name of the daemon that will take this daemon ========= job if it dies
    # AvailableIMPORTANT:
    # - Simple-log * a spare_daemon can only be the spare of 1 (and :only saveone) all logs into a common filemaster daemon
    # - WebUI * a spare_daemon cannot have a spare_daemon
    #   * the spare :must visualisationhave interface
modules with the same #module_type -as Graphite-Perfdatathe master
    :# save all metrics into a- graphitedepending database
of the value of # - slathe broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
    # Example: spare_daemon             : savebroker-spare
 sla into a databasespare_daemon

    # -1 Livestatus= (default) the spare defined with spare_daemon must have the same module_type :as TCPthis APImaster
 to query element state,# used0 by= nagiosthe externalspare toolsmodule_type likeare NagVisnot or Thrukchecked
    # - event-manager-writer  : save events for events manager (do not forget to activate the module in your webui to see data)
    modules      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             Simple-log, WebUI, Graphite-Perfdata, sla, event-manager-writer
    3

    #======== Realm and architecture settings =========
    # Realm to set this daemon into
    realm       data_timeout: how many second to consider a configuration transfer to be failed
    # because the network bandwidth is too small.
    data_timeout              All120

    # 1 = take data from the daemon realm and its sub realms
max_check_attempts: how many fail check to consider this daemon as DEAD
    max_check_attempts       # 03

 = take data only# fromCheck thethis daemon every X realmseconds
    manage_sub_realmscheck_interval            160


    # In NATted environments, you declare each satellite ip[:port] as seen by======== Modules to enable for this daemon =========
    # Available:
    # *this*- brokerWebUI (if port not set, the port declared by satellite itself
    # is used)
   : #satellitemapVisualisation interface
   scheduler-1=1.2.3.4:7768, poller-1=1.2.3.5:7771

 # - Graphite-Perfdata    # Exchange between brokers: <-Save schedulersall canmetrics beinto limiteda bygraphite packetdatabase
 size (in kB)
 # - sla # Note: as compression is automatic, this is a higher limit, and in real case the
    # : Save sla into a database
 packets will be lower# than- thisLivestatus value
    # broks_packet_size 1024


    #======== Memory protection =========
    # Are the daemon module process and worker process are waiting for enough : TCP API to query element state, used by nagios external tools like NagVis or Thruk
    # memory - broker-module-livedata  : REST API to bequery all availablemonitored beforeelement being launch. Default: 1 (enabled)
data (host, cluster or check)
     broker__manage_brok__enable_sub_processes_memory_usage_protection   1

    # The sub process memory usage protection can have a system reserved memory# - event-manager-writer    : Save events for events manager (do not forget to activate the module in your webui to see data)
    # that won't be used by theses sub process when launched
- Simple-log            # By default: 0Save (noall reservedlogs memory)
into a common file, # 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
    # it will be retry and wait that the system memory is freed until it fail to start
    # By default: 5 (seconds)
    broker__manage_brok__sub_processes_memory_usage_protection_max_retry_time   5


    #======== Brok pusher worker =========Use this module only if you need to have all the check results in one file.
    modules                  WebUI, Graphite-Perfdata, sla, event-manager-writer
    

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

    # The1 broker= spawntake broks pusherdata from the daemon realm and its sub processrealms
 to push to external# modules0 (like WebUI)
    # the broker will look at this worker execution time, and will kill if it timeout= take data only from the daemon realm
    manage_sub_realms        1

    # TheIn brokerNATted willenvironments, computeyou thedeclare averageeach execution time of previous workers tosatellite ip[:port] as seen by
    # decide about how many time this worker will take based on:*this* daemon (if port not set, the port declared by satellite itself
    # numberis ofused)
 broks to send /#satellitemap past average send speed (broks/s) scheduler-1=1.2.3.4:7768, scheduler-2=1.2.3.5:7771

    # IfExchange thisbetween timebrokers is<- reach,schedulers itcan meansbe thatlimited theby pusherpacket processsize is(in killedkB)

    # ForNote: smallas amountcompression of broks to sendis automatic, itthis shouldis leada to ridicusly small allowed execution timehigher limit, and in real case the
    # and the fac to spawn the subpackets processwill can be higherlower than this value,
 so we are using a minimal# broks_packet_size 1024


    # execution timeout======== Memory protection =========
    # Default:Are 5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeout           5

the daemon module process and worker process are waiting for enough
    # Inmemory order to managebe theavailable factbefore thatbeing thelaunch. serverDefault: can slow down during this send, you can setup a1 (enabled)
    broker__manage_brok__enable_sub_processes_memory_usage_protection   1

    # ratioThe thatsub willprocess bememory usedusage toprotection increasecan thehave alloweda timeoutsystem byreserved multiply itmemory
    # Default: 5
    broker__manage_brok__sub_process_broks_pusher_security_ratio that won't be used by theses sub process when launched
    # By default: 0 (no         5
reserved memory)
    # AtExample: the10 broker start(means without10% stats,of thisthe valudtotal willmemory beis usedreserved for the timeout
    # Default: 240 (secondssystem)
    broker__manage_brok__sub_process_broksmemory_pusherusage_maxsystem_executionreserved_timeoutmemory           2400

    # If a sub process reachcannot abe timeout,started itbecause willof bethe killedprotection, andhow relaunched. After max retry,many seconds
    # theit attachedwill modulebe willretry beand restarted
wait that the system #memory Default:is 3
freed until it  broker_fail to start
    # By default: 5 (seconds)
    broker__manage_brok__sub_processes_processmemory_broksusage_pusherprotection_max_retry_time                       35



    #======== EnableBrok orpusher notworker this daemon =========
    # 1The = is enabled, 0 = is disabled
    enabled  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
    # The broker will compute the average execution time of previous workers 1

}

to
    # decide about how many time this worker will take based on:
    # number of broks to send / past average send speed (broks/s)
    # If this time is reach, it means that the pusher process is killed

    # For small amount of broks to send, it should lead to ridiculously 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: 5 (second)
    broker__manage_brok__sub_process_broks_pusher_min_execution_timeout           5

    # 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: 5
    broker__manage_brok__sub_process_broks_pusher_security_ratio                  5

    # At the broker start without stats, this valid will be used for the timeout
    # Default: 240 (seconds)
    broker__manage_brok__sub_process_broks_pusher_max_execution_timeout           240

    # If a sub process reach a timeout, it will be killed and relaunched. After max retry,
    # the attached module will be restarted
    # Default: 3
    broker__manage_brok__sub_process_broks_pusher_max_retry                       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.

Checks impactés :

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