Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Options

...

de configuration 

En créant ou éditant votre fichier de configuration ,gardez à l'esprit que :

  • les lignes commençant par le caractère

When creating and/or editing configuration files, keep the following in mind:

  • Lines that start with a '"#"' character are considered to be comments and are not processed
  • Variable names are case-sensitive
  • If you want to configure a process to use a specific module:

 

  • sont considérés comme des commentaires 
  • les noms de variable sont sensibles aux majuscules/minuscules

Le fichier principal de configuration est  The main configuration file is "shinken.cfg". It is located in the Il est situé dans le répertoire "/etc/shinken/" directory.Below are listed parameters currently used in the file. For other parameters (not set by default) see Advanced Configuration.

...

.


Ci dessous, la liste des paramètres utilisés. Pour les autres paramètres  (non  réglés par défaut ) voir Configuration avancée.

Options utilisées par défaut

 

Cfg dir

...

et Cfg files

Format :

cfg_dir=<directory_name>
cfg_file=<file_name>

Those are statements and not parameters . The arbiter considers them as order to open other(s) configuration(s) file(s)
For the Ceux-ci sont des assertions, et non des paramètres . L'arbiter les considèrent comme des ordres pour ouvrir d'autre(s) fichier(s) de configuration. 
Pour le cfg_dir one, the arbiter only reads files ending with l'arbiter lit uniquement les fichiers se terminant par ".cfg".
The arbiter does read recursively directory for files but does not consider lines into those files as statements anymore.L'arbiter lit les directives de manière récursive pour les fichiers, mais ne considère plus les lignes à l'intérieur comme assertions. 

Cela signifie que les fichiers cfg_dir ou cfg_file sont considérés comme paramètres en dehors de Shinken.cfg 
L'arbiter gère le fichier principal de configuration différemment des autres fichiers. This means that a cfg_dir or cfg_file is considered as a parameter outside of shinken.cfg (or any configuration file directly given to the arbiter as parameter in a command line)
The arbiter handles main configuration files differently than any other files.

Automatic State Retention Update Interval

Format: 

retention_update_interval=<minutes>

DefaultDéfaut: 

retention_update_interval=60

This setting determines the interval (in minutes) between automatic retention data backups by the scheduler during normal operation.
If you set this value to 0, it will not save retention data at regular intervals, but it will still save retention data before shutting down or restarting.Ce paramètre détermine l'intervalle (en minutes) entre chaque backup de rétention automatique de données par le scheduler en opération normale.
Si vous mettez cette valeur à 0, il ne sauvegardera pas les données de rétention à intervalle régulier, mais seulement à l'arrêt et au redémarrage. 

Maximum Host/Service Check Spread

Format: 

max_service_check_spread=<minutes>
max_host_check_spread=<minutes>

DefaultDéfaut: 

max_service_check_spread=30
max_host_check_spread=30

This option determines the maximum time spread (in minutes) to check all hosts/checks (which are scheduled to be regularly checked) from Shinken Enterprise's launch. This option will ensure that the initial checks of all hosts/checks occur within the timeframe you specify. Default value is Cette option détermine l'écart de temps maximum (en minutes) pour vérifier tous les hôtes/checks  (qui sont planifiés pour être vérifiés régulièrement). Cette option garantira que les vérifications initiales se feront dans la période de temps définie. Par défaut, la valeur est 30 (minutes).


Service/Host Check Timeout

Format:

 

service_check_timeout=<seconds>
host_check_timeout=<seconds>

DefaultDéfaut: 

service_check_timeout=60
host_check_timeout=30

This is the maximum number of seconds allowed by Shinken Enterprise to run host/checks. If checks exceed this limit, they are killed and a CRITICAL state is returned. A timeout error will also be logged.

Il s'agit du nombre maximum de secondes qu'autorise Shinken Enterprise pour lancer les  hôtes/checks. Si les vérifications dépassent cette limite, elles sont supprimées et un statut CRITICAL est retourné. Une erreur timeout sera également logguée. 

Il y a souvent une confusion répandue,  sur ce que cette option fait vraiment. Elle est destinée à être utilisée comme un mécanisme de dernier rempart, pour tuer les plugins qui se comportent mal . Elle doit être réglée sur une valeur haute (quelque chose comme 60 secondes ou plus ) , de sorte que chaque vérification soit dans ce délai . Si une vérification se fait sur  longueur supérieure à cette limite , Shinken Enterprise va la tuer , pensant que c'est un processus d'emballementThere is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off plugins which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each check normally finishes executing within this time limit. If a check runs longer than this limit, Shinken Enterprise will kill it off thinking it is a runaway process.

Timeout Exit Status

Format: 

timeout_exit_status=[0,1,2,3]

 

DefaultDéfaut:

 

timeout_exit_status=2

State set by Etat défini par Shinken Enterprise in case of en cas de timeout.

 

Flap History

Format: 

flap_history=<int>

 

DefaultDéfaut:

 

flap_history=20

This option is used to set the history size of states kept by the scheduler to make the flapping calculation. By default, the value is 20 states kept.

Cette option est utilisée pour définir la taille de l'historique gardé par le scheduler pour réaliser le calcul de l'état flapping .Par défaut, la valeur de 20 états gardés. 

La taille mémoire est pour le démon scheduler  The size in memory is for the scheduler daemon : 4Bytes flap_history (nb hosts + nb checks). For a big environment, it costs Pour un environnement important, il faut 4 20 (1000+10000) - 900Ko. So you can raise it to higher value if you want .

Max Plugins Output Length

Format: 

max_plugins_output_length=<int>

 

DéfautDefault: 

max_plugins_output_length=8192This option is used to set the max size in bytes for the checks plugins output. So if you saw truncated output like for huge disk check when you have a lot of partitions, raise this value

.Cette option est utilisée pour définir la taille max en bytes pour les retours de plugins de checks .Si vous voyez des valeurs tronquées, comme par exemple pour des gros checks de disque, augmentez la valeur.  

Enable problem/impacts states change

Format:

 

enable_problem_impacts_states_change=<0/1>

 

DefaultDéfaut: 

enable_problem_impacts_states_change=0This

option is used to know if we apply or not the state change when a host or check is impacted by a root problem (like the check's host going down or a host's parent being down too). The state will be changed by UNKNONW for a check and UNREACHABLE for a host until their next schedule check. This state change does not count as an attempt, it's just for console so the user knows that these objects got problems and the previous states are not sure.Cette option est utilisée si on applique le changement d'état lorsqu'un hôte ou un check est impacté par un problème cause. L'état sera changé à UNKNONW pour un check et UNREACHABLE pour un hôte jusqu'au lancement du prochain check.  Le changement d'état ne compte pas comme une tentative, c'est juste pour la console afin que l'utilisateur sache que ces objets ont des problèmes et que leurs états précédents n'étaient pas sûrs.  

Disable Old Nagios Parameters Whining

Format:

 

disable_old_nagios_parameters_whining=<0/1>

 

DefaultDéfaut: 

disable_old_nagios_parameters_whining=0

If Si 1, disable all notice and warning messages at configuration checkingdésactive toutes les notifications et messages à la vérification de la configuration 

 

Timezone Option

Format: 

use_timezone=<tz from tz database>

 

DefaultDéfaut: 

use_timezone=''This option

allows you to override the default timezone in which an instance of Shinken Enterprise runs. Useful if you have multiple instances of Shinken Enterprise which need to run from the same server, but have different local times associated with them. If not specified, Shinken Enterprise will use the system configured timezone.Cette option permet d'outrepasser la zone de temps définie par défaut pendant laquelle l'instance Shinken Enterprise tourne . C'est très utile si vous avez plusieurs instances qui doivent tourner sur le même serveur, mais avec des plages horaires différentes . Si rien n'est spécifié, Shinken Enterprise utilisera la plage horaire du système. 

 

Environment Macros Option

Format: 

enable_environment_macros=<0/1>

 

Default: 

enable_environment_macros=0

This option determines if the Shinken Enterprise daemon will make all standard Cette option détermine si le démon Shinken Enterprise va rendre disponibles les :ref:`macros <thebasics/macrolist>` available as environment variables to your check, notification, event hander, etc. commands. In large installations this can be problematic because it takes additional CPU to compute the values of all macros and make them available to the environment. It also cost a increase network communication between schedulers and pollers.

  • 0 = Don't make macros available as environment variables

comme variables d'environnement pour les checks, notifications, gestionnaires d'événements, etc. Dans des installations importantes, cela peut être problématique car il nécessite de la CPU supplémentaire pour calculer les valeurs des macros et les rendre disponibles . Cela rajoute également de la communication réseau entre les schedulers et les pollers.

  • 0 = ne rend pas les macros disponibles en tant que variables d'environnement
  • 1 = rendent les macros disponibles comme variables d'environnement 1 = Make macros available as environment variables

 

Initial States Logging Option

Format: 

log_initial_states=<0/1>

 

DefaultDéfaut:

 

log_initial_states=1This

Cette variable determines if Shinken Enterprise will force all initial host and check states to be logged, even if they result in an OK state. Initial check and host states are normally only logged when there is a problem on the first check. Enabling this option is useful if you are using an application that scans the log file to determine long-term state statistics for checks and hosts.détermine si Shinken Enterprise tous les états initiaux des hôtes et des checks à être loggués, même si le résultat est un état OK . Les état initiaux ne sont normalement loggués que lorqu'il y a un problème sur le 1er check. Activer cette option est utile si vous avez une application qui scanne le fichier log pour définir des statistiques long terme.  

  • 0 = ne loggue pas les états initiauxDon0 = Don't log initial states
  • 1 = Log initial statesloggue les états initiaux 

Event Handler during downtimes

Format:

 

no_event_handlers_during_downtimes=<0/1>

 

Default: 

no_event_handlers_during_downtimes=1

This Cette option determines if détermine si Shinken Enterprise will run va lancer  :ref:`event handlers <advanced/eventhandlers>` when the host or check is in a scheduled downtimelorsque l'hôte ou le check  est maintenance planifiée .

  • 0 = Launch event handlers (Nagios behaviorLancement de gestionnaire d'événements (comportement Nagios)
  • 1 = Don't launch event handlersNe lance pas le gestionnaire d'événements 

 

Arbiter daemon part

Partie démon Arbiter 

Les paramètres suivants sont communs à tous les démons The following parameters are common to all daemons .

Workdir

Format:

 

workdir=<directory>

 

Default Défaut : 

workdir=/var/run/shinken/

This variable specify the working directory of the daemon.
In the arbiter case, if the value is empty, the directory name of lock_file parameter. See below

 Cette variable spécifie le répertoire de travail du démon .
Dans le cas de l'arbiter, si la valeur est vide ou absente, c'est le répertoire du paramètre lock_file qui sera pris.

Arbiter Lock File

Format: 

lock_file=<file_name>

 

ExempleExample: 

lock_file=/var/lib/shinken/arbiterd.pid

This option specifies the location of the lock file that arbiter daemon should create when it runs as a daemon (when started with the Cette option spécifie l'emplacement du fichier lock que l'arbiter doit créer lorsqu'il tourne en tant que démon (démarré avec l'argument de la ligne de commande  "-d" command line argument). This file contains the process id (PID) number of the running arbiter process). Ce fichier contient le numéro de l'id du process (PID) de l'arbiter qui tourne.

 

Local Log

Format:

 

local_log=<filename>

 

DéfautDefault:

 

local_log=/var/log/shinken/arbiterd.log'


This variable specifies the log file for the daemonCette variable spécifie le fichier log file pour le démon.

Log Level

Format: 

log_level=[DEBUG,INFO,WARNING,ERROR,CRITICAL]

 

DefaultDéfaut: 

log_level=WARNING


This Cette variable specifies which logs will be raised by the arbiter daemon. For others daemons, it can be defined in their spécifie quelles logs seront remontées par l'arbiter . POur les autres démons, cela peut être défini dans leur fichier local \ d.ini files.

 

Arbiter Daemon User

Defined in Défini dan brokerd.ini, brokerd-windows.ini, pollerd.ini, pollerd-windows.ini, reactionnerd.ini, schedulerd.ini and schedulerd-windows.ini.

Format: 

shinken_user=username

 

DéfautDefault: 

shinken_user=<current user>

This is used to set the effective user. The Arbiter process (main process) will run as this effective user.
After initial program startup, Shinken Enterprise will drop its effective privileges and run as this user.C'est utilisé pour définir le user actif. Le process de l'arbiter  (process principal) va tourner en tant que user actif. 
Après le démarrage initial du programme, Shinken Enterprise va laisser tomber ses privilèges et tournera en tant que ce user actif. 

 

Arbiter Daemon user Group

Format:

 

shinken_group=groupname

 

DefaultDéfaut: 

shinken_group=<current group>This is used to set the effective group of the user used to launch the arbiter daemon.

C'est utilisé pour définir le bon groupe utilisateur pour lancer l'arbiter. 

 

Modules directory

Format: 

modules_dir=<direname>

 

DefaultDéfaut: 

modules_dir=/var/lib/shinken/modulesPath to the modules directory


Chemin vers le répertoire modules 

 

Daemon Enabled

Format: 

daemon_enabled=[0/1]

 

DéfautDefault:

daemon_enabled=1

Set to 0 if you want to make this daemon (arbiter) NOT to runValidé à  0 si vous souhaitez que ce démon (arbiter) NE FONCTIONNE PAS 

 

Use SSL

Format:

 

use_ssl=[0/1]

 

DefaultDéfaut: 

use_ssl=0

Use SSl or not. You have to enable it on other daemons tooUtiliser  SSl ou pas. Vous devez l'activer dans les autres démons également .

 

Ca Cert

Format: 

ca_cert=<filename>

 

DéfautDefault: 

ca_cert=etc/certs/ca.pem

Certificat de Certification Authority (CA) certificate. Put full paths for certs

Server Cert

Format: 

server_cert=<filename>

 

DefaultDéfaut: 

server_cert=etc/certs/server.cert

Server certificate for SSL.Put full paths for Certificat serveur pour SSL. Chemin complet mis pour certs

Server Key

Format: 

server_key=<filename>

 

DefaultDéfaut:

 

server_key=/etc/certs/server.keyServer key for SSL. 

Put full paths for Clé serveur pour SSL. Chemin complet mis pour certs

 

Hard SSL Name Check

Format: 

hard_ssl_name_check=[0/1]

 

DefaultDéfaut: 

hard_ssl_name_check=0

Enable SSL name checkActive le nom du check SSL .

 

HTTP Backend

Format: 

http_backend=[auto, cherrypy, swsgiref]

 

DefaultDéfaut: 

http_backend=cherrypy

Specify which Specifie quel http_backend to useutiliser.