...
...
| viewport | true |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll- |
|---|
|
...
...
...
...
...
...
...
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
Le Broker reçoit toutes les données des Schedulers.
...
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
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
Image Removed
Résumé des connexions du Broker
...
Description des variables
...
broker_name
...
address
...
Ce sont les objets Broks.
| Info |
|---|
|
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
|
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 Added
|
Résumé des connexions du Broker
| Source | Destination | Port | Protocole | Note |
|---|
| Broker | Scheduler | 7768 | HTTP/HTTPS |
|
Description des variables
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| Texte | — | __ | Cette variable est utilisée pour identifier le nom réduit du Broker auquel les données sont associées. | | URL | — | localhost | Définit l'adresse permettant de joindre ce Broker. Par défaut "localhost", changez-le par un nom DNS ou une adresse IP. | | Entier | __ | 7772 |
|
...
Port TCP utilisé par le démon. | | Booléen | __ | 0 |
|
...
Définit si le Broker doit être contacté en HTTPS |
|
...
...
...
...
...
...
Broker peut être géré comme un spare ( prendra uniquement la configuration si le maître échoue ). |
|
...
Valeurs possibles: - 1 ( Activé )
- 0 ( Désactivé )
| |
|
...
...
| 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 |
|
...
...
vérifiée pour voir si elle corresponds bien à celle du |
|
...
timeout
...
maitre. Valeurs possibles: - 1 ( Activé )
- 0 ( Désactivé )
| | Entier | Seconde | 3 | 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, |
|
...
Shinken conseille alors d'augmenter |
|
...
la valeur de timeout ( l'Arbiter aura besoin de plus d'allers/retours pour le contacter ). | | Entier | Seconde | 120 |
|
...
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 . |
|
...
| | Entier | Seconde | 60 | Intervalle de Ping |
|
...
...
...
les modules chargés par le |
|
...
...
| 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 |
|
...
...
Broker prendra des tâches des Schedulers des sous-royaumes. Valeurs possibles: - 1 ( Activé )
- 0 ( Désactivé )
| | Booléen | __ | 1 | Prends les données de l'Arbiter. Il ne devrait y avoir qu'un seul |
|
...
...
satellitemap
Valeurs possibles: - 1 ( Activé )
- 0 ( Désactivé )
| | 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 |
| Entier | Kilo-octet | 204800 | 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 |
|
|
...
| Entier | Pourcentage | 0 | 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 |
| Entier | Seconde | 5 | Dans le cas de la protection mémoire, pendant combien de temps le |
|
...
...
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 |
| Entier | Seconde | 5 | Temps |
|
...
...
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 |
| Entier | Seconde | 240 | Temps |
|
...
...
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é. |
|
...
enabled
...
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) :
Il est conseillé d'éditer les fichiers .cfg avec l'encodage utf-8
...
...
| 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 |
| Entier | Millisecondes | 100 | 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 |
| Entier | Millisecondes | 500 | 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. |
| | Booléen | __ | 1 | Définit si le Broker est activé ou non. Valeurs possibles: - 1 ( Activé )
- 0 ( Désactivé )
|
|
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 ) :
Il est conseillé d'éditer les fichiers .cfg avec l'encodage utf-8
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
#===============================================================================
|
...
...
...
=============================================================
# 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
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
broker-master
# IP/fqdn of this daemon (note: you |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
localhost
# Port (HTTP/HTTPS) exposed by this daemon
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
#======== Master or spare selection =========
# 1 = |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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 |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
type as the master
# - depending |
...
...
the broker__manage_spare__spare_must_have_the_same_list_of_module_type parameter
# Example: spare_daemon broker-spare
|
...
...
...
...
...
...
...
defined with spare_daemon must |
...
have the same module_type as this master
# 0 |
...
...
module_type are not checked
# broker__manage_spare__spare_must_have_the_same_list_of_module_type 1
#======== Daemon |
...
...
...
...
...
...
...
...
...
...
...
a node don't answer
timeout |
...
...
...
...
...
...
...
...
...
...
...
3
# data_timeout: how many second to consider a configuration transfer to be |
...
...
because the network bandwidth is too small.
data_timeout |
...
...
...
120
# max_check_attempts: how many fail check to consider this daemon as |
...
...
...
...
...
...
...
...
3
# Check this daemon every X seconds
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
======== Modules to enable for this daemon =========
# Available:
# - WebUI : Visualisation interface
|
...
...
...
...
...
...
...
...
...
...
: Save all metrics into a graphite database
# - sla |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
tools like NagVis or Thruk
# |
...
...
-module-livedata : REST API to query all monitored element data (host, cluster or check)
# - event-manager-writer : Save events for events manager (do not forget to activate the module in your webui to see data)
# - Simple-log |
...
...
...
...
...
...
...
...
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 WebUI, Graphite-Perfdata, sla, event-manager-writer
# |
...
======== Realm and architecture settings =========
# |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
= take data only from the daemon realm
manage_sub_realms 1
# |
...
In NATted environments, you declare each satellite ip[:port] as seen by
# *this* daemon (if port not set, the port declared by satellite itself
# |
...
is used)
#satellitemap scheduler-1=1.2.3.4:7768, scheduler-2=1.2.3.5:7771
# |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
as compression is automatic, this is a higher limit, and in real case the
# |
...
...
...
...
...
...
...
...
...
...
...
broks_packet_size 1024
#======== Memory protection =========
# |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
launch. Default: 1 (enabled)
broker__manage_brok__enable_sub_processes_memory_usage_protection 1
# |
...
...
...
...
...
...
...
...
...
...
that won't be used by theses sub process when launched
# By default: 0 (no reserved memory)
# Example: 10 (means 10% of the total memory is reserved for the system)
broker__manage_brok__sub_process_ |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
By default: 5 (seconds)
broker__manage_brok__sub_ |
...
processes_memory_usage_protection_max_retry_time 5
#======== Brok pusher worker =========
# The broker |
...
...
...
...
...
...
...
...
(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 to
# decide about how many time this worker will take based on:
# |
...
...
...
...
...
...
...
...
# If this time is reach, it means that the pusher process is killed
# For small amount of broks to send, it should |
...
...
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 |
|---|
|
| Scroll Title |
|---|
| anchor | data_for_check_sup_de_sup |
|---|
| title | |
|---|
| | Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|
| 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
| |
|