Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=merge_page

...

Description des variables

Propriété



Scroll Title
anchorparameter_cfg
NomTypeUnitéDéfautCommentaire
Description
No Format
broker_name
N/A
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
Cette directive est utilisée pour définir

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
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 ) La valeur par défaut est

ou HTTP

( 0 ).

.

Valeurs possibles:

  • 1 ( HTTPS )
  • 0 ( HTTP )
.


No Format
spare
Booléen
0Cette variable est utilisée pour définir
__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
La valeur par défaut est 0 ( maître ).
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
1Si cette option est désactivée ( 0 ), alors
Booléen__1

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 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 alors d'augmenter cette 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
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.

No Format
realm
N/A
Texte____

Définit

Cette variable est utilisée pour définir

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

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.

Broker pour l'Arbiter.

Valeurs possibles:

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

__

__

satellitemap

N/A

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

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 ( en secondes )

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

( en secondes )

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

( en secondes )

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

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
#===============================================================================
# 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_same_list_of_module_type parameter
    # 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_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                   3

    # data_timeout: how many second to consider a configuration transfer to be failed
    # because the network bandwidth 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            60


    #======== Modules to enable for this daemon =========
    # Available:
    # - WebUI                          : Visualisation interface
    # - Graphite-Perfdata              : Save all metrics into a graphite database
    # - sla                            : Save sla into a database
    # - Livestatus                     : TCP API to query element state, used by nagios external tools like NagVis or Thruk
    # - broker-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                     : 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                  WebUI, Graphite-Perfdata, sla, event-manager-writer


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

    # 1 = take data from the daemon realm and its sub realms
    # 0 = take data only from the daemon realm
    manage_sub_realms        1


    # 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

    # Exchange between Brokers <- Schedulers can be limited by packet size (in kB)
    # Note: 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 =========
    # 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

    # The sub process memory usage protection can have a system reserved memory
    # 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_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 =========
    # 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
    # The Broker will compute the average execution time of previous workers 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



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

}