Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 22
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltruefalse
Panel
titleSommaire

Table of Contents
stylenone

Cette page explique les paramètres présents dans le fichier /etc/shinken/synchronizer.cfg


Si vous souhaitez apporter des modifications à ces paramètres, il est conseillé de modifier le fichier suivant : /etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg

Configuration des logs

La partie des logs du Synchronizer se gère avec ces paramètres :

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== logging =========

# The synchronizer can have it's own local log
local_log=/var/log/shinken/synchronizerd.log


# If you disable, the timestamp will be an epoch integer instead of a human date
human_timestamp_log=1
#==================================================================================

Les paramètres sont les suivants :

NomTypeUnitéDéfautCommentaire
No Format
local_log 
Texte--- /var/log/shinken/synchronizerd.log Emplacement du fichier de log du Synchronizer
No Format
human_timestamp_log 
Booléen--- 1

Permet d'afficher les logs avec un affichage de la date lisible facilement.

  •  => date au format "humain"
  • => pour avoir un timestamp, si vous utilisez un système de gestion de log par exemple.

Paramètres du démon

Les paramètres suivants permettent de configurer le démon sur le serveur :

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== System synchronizer daemon parameters (user, group, pid, ...) =========


# Lock file (with pid) for the sycnhronizer daemon
lock_file=/var/run/shinken/synchronizerd.pid


# User that will be used by the synchronizer
shinken_user=shinken
shinken_group=shinken

# Set to 0 if you want to make this daemon NOT run
daemon_enabled=1


# The path to the modules directory
modules_dir=/var/lib/shinken/modules

# The path to the share files
share_dir=/var/lib/shinken/share

#==================================================================================



#==================================================================================
#======== Listening address (daemon) =========

# If enabled, the synchronizer daemon will listen in HTTPS instead of HTTP protocol.
# Note: default pem/cert and key files are for sample only. You need to generate
# your own with your PKI.
# by default: 0 (disabled)
use_ssl=0
ca_cert=/etc/shinken/certs/ca.pem
server_cert=/etc/shinken/certs/server.cert
server_key=/etc/shinken/certs/server.key

# Should the synchronizer connections will force the HTTPS certificates name checks
# If enabled and a distant certificate is not the same as the daemon address, then
# the connection will be refused.

hard_ssl_name_check=0

# Which HTTP backend to start the listening daemon with.
# Currently only auto is managed
http_backend=auto

# Which addr to bind for the synchronizer daemon
# by default: 0.0.0.0 (all interfaces)
bind_addr=0.0.0.0

#==================================================================================




Les paramètres sont les suivants :

Défini utiliser de sur Défini
NomTypeUnitéDéfautCommentaire
No Format
lock_file
Texte--- /var/run/shinken/synchronizerd.pid Le chemin vers le fichier qui contient le numéro de PID du démon.
No Format
shinken_user
Texte--- shinken Utilisateur Unix qui sera utilisé par le démon
No Format
shinken_group
Texte--- shinken Groupe Unix qui sera utilisé par le démon
No Format
daemon_enabled
Booléen--- 1

Définis si le démon est activé ou non.

Warning

Pour Activer ou désactiver le Synchronizer,

utilisez les commandes suivantes plutôt que

modifier le paramètre daemon_enabled :

  • shinken-daemons-disable synchronizer
  • shinken-daemons-enable synchronizer

Ces commandes permettent de vérifier que le Synchronizer est dans un état correct avant de démarrer afin de ne pas corrompre la base de données ( exécution de sanatize-data )

No Format
modules_dir
Texte--- /var/lib/shinken/modules Emplacement des modules Shinken
No Format
share_dir
Texte--- /var/lib/shinken/share Emplacement du dossier des fichiers partagés ( contiens les icônes affichées dans les listes de l'interface de configuration )
No Format
use_ssl
Booléen--- 0 Permets Permet de définir si les autres démons doivent communiquer en SSL lorsqu'ils s'adressent au Synchronizer ( actuellement, seul l'Arbiter communique avec le Synchronizer ).
Ne concerne pas l'interface de configuration.
No Format
ca_cert
Texte--- /etc/shinken/certs/ca.pem Chemin de l'autorité de certification qui a généré le certificat SSL
No Format
server_cert
Texte--- /etc/shinken/certs/server.cert

Chemin du certificat SSL

Info
titleSSL

Par défaut un certificat auto signé est livré afin de pouvoir mettre en place rapidement et facilement une sécurité sur les communications des démons. Il est conseillé d'utiliser vos propres certificats

surs du plus long terme.

No Format
server_key
Texte--- /etc/shinken/certs/server.key Chemin de la clé SSL
No Format
hard_ssl_name_check
Booléen--- 0

Permet de forcer la vérification du nom du certificat avec le nom du serveur distant.

  • Cette option est désactivée par défaut, car le certificat livré dans l'installation est un certificat auto signé.
No Format
http_backend
Texte--- auto

Permet de définir le moteur HTTP à utiliser.

  • Pour le moment, seul le paramètre auto est géré.



No Format
bind_addr



Texte--- 0.0.0.0

Définis l'interface qui sera en écoute sur le réseau.

  • La valeur 0.0.0.0 ( par défaut ) permet d'écouter sur toutes les interfaces.




Configuration de l'interface de configuration

Les paramètres suivants permettent de configurer l'interface accessible depuis votre navigateur :

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== Listening address (Configuration interface) =========

# Http(s) port to listen the Configuration interface
http_port=7766


# Select the lang that will be used by default on the UIs
# Currently managed:
# -en    (english)
# -fr    (francais)
lang=fr


# set the Configuration interface into HTTPs or not (disabled by default)
http_use_ssl=0

# Mandatory is SSL is enabled: server key and certificate
http_ssl_cert=/etc/shinken/certs/server.cert
http_ssl_key=/etc/shinken/certs/server.key

# Cookie secret password. Is used to crypt cookies
auth_secret=AUTH-SECRET-_RqRGhiNimAebzJRAY6Hx3mGGbxSlq_gx7Jirdz9ki4co8rK9yeQ8f_1qWDuRXT8CSTeHgXBZ9N1eKBwuQnh9-5sWmZJn5e2MHOOk0jC7gIUFzfUeJsSHVRx3YLEBRpIP9WjYfGoPNkPq4tE64aZlR1Mukj_iRnC-D8KX4P0zHKj_BJP_aws_ZzKR5l36rGrPozfdW0KryhdDTrwEg-me34MM22uQDjk_jYAF--ZHRMGgE5jY3gd_fXXlBEH29Ao

# Master key for CLI access
master_key=MASTERKEY-KUMi_DY49LtZTLI3XMiabDT5f_OyErn-8oH1Ew0z7kv86y5zNjm2bJ-Wf50cfy5Hwc1BTMBhA747p0_sKwd-YAtbD2D9mmBY8ecBAvMmXIqRCaAe86GyBrQzQRaLz6_x38rjBT1ImAcwZwwE1U1tiI3qhLS4cRsRZHCP_DcKJ2XTDbYL7eoeBdc9FRUApTmP6S5xdonY6_lteiBiUgceuJQkbCy94l6Es5yTzCH3PDqj11hy86hE9yekAmkgZkJz


# Remote application authentification
# if 1: allow the user to be load from a HTTP Header
http_remote_user_enable=0

# which HTTP header to get user name if remote_user_enable is 1
http_remote_user_variable=X_Remote_User
# if remote_user_enable is 1,
# http_remote_user_case_sensitive to 1 enable case check on remote user login
# http_remote_user_case_sensitive to 0 disable case check on remote user login
# default value : 1, login is case sensitive
http_remote_user_case_sensitive=1

#==================================================================================


#==================================================================================
#======== INTERNAL OPTIONS =========

# On source page, some errors or warnings may concern many elements. A summary is shown
# for this error and you can set the number of message who are in this summary.
number_of_message_in_source_summary=5


#==================================================================================



Les paramètres sont les suivants :

utilisé
NomTypeUnitéDéfautCommentaire
No Format
http_port
Entier positif--- 7766 Le port
utilisa par l'interface
No Format
lang
Texte--- dépend de la version installé Langue de l'interface. La valeur par défaut est "fr" pour un installeur FR, "en" pour un installeur US.
No Format
http_use_ssl
Booléen--- 0 Permet de définir si l'interface sera accessible par HTTP ( valeur "0" ) ou HTTPS ( valeur "1" )
No Format
http_ssl_cert
Texte--- /etc/shinken/certs/server.cert Certificat SSL
No Format
http_ssl_key
Texte--- /etc/shinken/certs/server.key Clé du certificat SSL
No Format
auth_secret
Texte--- générée lors de l'installation Clé générée à l'installation permettant de chiffrer les cookies
No Format
master_key
Texte--- générée lors de l'installation Clé générée à l'installation permettant un accès CLI
No Format
http_remote_user_enable
Booléen--- 0 Permet de s'authentifier par un en-tête.
Cette option permet de configurer un accès SSO ( Single-Sign-One ) aussi appelé authentification unique..
No Format
number_of_message_in_source_summary
Entier positif--- 5 Permet de configurer le nombre de messages d'erreur ou d'avertissements dans le résumé d'une source

Configuration de la base de données du Synchronizer

La base de données utilisée utilisées est MongoDBMongoDb. Pour la configurer, vous aurez besoin de modifier les paramètres suivants :

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== Mongodb database connection =========
# database type. currently only mongodb is managed.
data_backend=mongodb

# mongodb uri definition for connecting to the mongodb database. You can find the mongodb uri
# syntax at https://docs.mongodb.com/manual/reference/connection-string/
mongodb_uri=mongodb://localhost/?safe=false

# mongodb database to use for this daemon.
mongodb_database=synchronizer

# If you want to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
# allow all mongodb to be encrypted & authentificated with SSH
# Should use a SSH tunnel (Default 0=False)
mongodb_use_ssh_tunnel=0

# If the SSH connection goes wrong, then retry use_ssh_retry_failure time
# Default: 1
mongodb_use_ssh_retry_failure=1

# SSH user/keyfile in order to connect to the mongodb server.
# Default: shinken
mongodb_ssh_user=shinken

# Default: ~shinken/.ssh/id_rsa
mongodb_ssh_keyfile=~shinken/.ssh/id_rsa

# Timeout to wait for mongodb queries, in seconds
# Default: 120
mongodb_mongo_timeout=120

# By default bailout the sychronizer if cannot contact mongodb for more than 120s
mongodb_retry_timeout=120

# TheEach timedatabase the historyrequest will be kept for syncronizations into database (in minutes)
sync_history_lifespan= tried X times before considering it as an error and abort
# Default : 15
synchronizer__database__retry_connection_X_times_before_considering_an_error=15
 
# We will wait X seconds between each try or any database request
# Default : 5
synchronizer__database__wait_X_seconds_before_reconnect=5

# The time the history will be kept for syncronizations into database (in minutes)
sync_history_lifespan=1440

#==================================================================================  


Les paramètres sont les suivants :

Défini Défini utilisé si la connexion à la base de données est encapsulée dans un tunnel SSHTemps de connexion maximum avant que la connexion ne soit considérée comme trop longue et cause un échec de connexion
NomTypeUnitéDéfautCommentaire
No Format
data_backend
Texte--- mongodb Moteur de base de données utilisé. Pour le moment, seule "mongodb" est gérée.
No Format
mongodb_uri
Texte--- mongodb://localhost/?safe=false Adresse de connexion à la base de données. La syntaxe est celle de mongo
No Format
mongodb_database
Texte--- synchronizer Le nom de la base de données utilisée
No Format
mongodb_use_ssh_tunnel
Booléen--- 0
Définis si la connexion à la base de données est directe ou doit être encapsulé dans un tunnel SSH.
No Format
mongodb_use_ssh_retry_failure
Booléen--- 1
Définis le nombre d'essais à réaliser si la connexion à la base de données est perdue
No Format
mongodb_ssh_user
Texte--- shinken L'utilisateur qui sera
utilisé si la connexion à la base de données est encapsulée dans un tunnel SSH
No Format
mongodb_ssh_keyfile
Texte--- ~shinken/.ssh/id_rsa La clé SSH qui sera utilisée si la connexion à la base de données est encapsulée dans un tunnel SSH
No Format
mongodb_mongo_timeout
Entier positif--- 120 Temps de connexion maximum avant que la connexion ne soit considérée comme trop longue et cause un échec de connexion
No Format
synchronizer__database__retry_connection_X_times_before_considering_an_error
Entier positif---15Nombre de tentatives à effectuer avant de considérer une requête en base de donnée comme étant en erreur
No Format
synchronizer__database__wait_X_seconds_before_reconnect
Entier positifSeconde5Temps d'attente entre chaque tentative de requête vers la base de données
No Format
mongodb_ssh_keyfile
Texte--- ~shinken/.ssh/id_rsa La clé SSH qui sera utilisée si la connexion à la base de données est encapsulée dans un tunnel SSH
No Format
mongodb_mongo_timeout
Entier positif--- 120
No Format
sync_history_lifespan
Entier positifMinute 1440 Le nombre de minutes durant lesquelles les derniers imports seront conservés dans la base de données. La valeur par défaut est de 1440 minutes soit 45 heures.



Info

Si votre base de données n'est pas hébergée sur le même serveur que le Synchronizer, il est préférable d'utiliser le tunnel SSH afin de ne pas exposer le port de la base de données sur le serveur distant.

Protection des données sensibles ( paramètres à ne pas modifier )

Warning

La modification manuelle de ces paramètres peut entraîner une corruption de la base de données.   La protection des données sensibles est configurable ( voir la page  Protection des données sensibles de l'UI de Configuration ).

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#=============== Protected fields security ====================
# Encryption for protected fields
protect_fields__activate_encryption=0
# File containing the encryption key
protect_fields__encryption_keyfile=/etc/shinken/secrets/protected_fields_key
# List of words contained in protected fields names
# Default values : PASSWORD,PASSPHRASE,PASSE,DOMAINUSER,MSSQLUSER,MYSQLUSER,ORACLE_USER,SSH_USER,LOGIN
protect_fields__substrings_matching_fields=PASSWORD,PASSPHRASE,PASSE,DOMAINUSER,MSSQLUSER,MYSQLUSER,ORACLE_USER,SSH_USER,LOGIN
#==================================================================================

  

Les paramètres sont les suivants :

NomTypeUnitéDéfautCommentaire
No Format
protect_fields__activate_encryption
Booléen--- 0 Définit si la protection est active
No Format
protect_fields__encryption_keyfile
Texte--- /etc/shinken/secrets/protected_fields_key Chemin de la clé de protection
No Format
protect_fields__substrings_matching_fields
Texte---
  • PASSWORD,
  • PASSPHRASE,
  • PASSE,
  • DOMAINUSER,
  • MSSQLUSER,
  • MYSQLUSER,
  • ORACLE_USER,
  • SSH_USER,
  • LOGIN
Chaîne de caractère générant une protection des données
Warning

La définition de ces paramètres est volontairement peu détaillée, car ils sont modifiés par les commandes Shinken adéquates. Ces commandes sont expliquées dans la page indiquée dans l'avertissement précédent.

Architecture de Shinken ( paramètres à ne pas modifier )

Warning

Les paramètres suivants sont gérés par Shinken. Ils peuvent être modifiés par les commandes Shinken ou par l'installeur. Il est conseillé de ne pas modifier les valeurs. Les paramètres sont modifiables ( voir la page Surcharge des paramètres du démon ( synchronizer_cfg_overload.cfg ) ).


Les paramètres suivants permettent au Synchronizer de connaître les dossiers dans lesquels lesquelles seront placés les fichiers de configurations (modules, démons, packs, données globales, fichier de surcharge)


noformat
Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== Modules and architecture =========

# sub directories to load. do not edit
cfg_dir=modules
cfg_dir=arbiters
cfg_dir=schedulers
cfg_dir=pollers
cfg_dir=reactionners
cfg_dir=brokers
cfg_dir=receivers
cfg_dir=realms
cfg_dir=synchronizers
cfg_dir=sources
cfg_dir=listeners
cfg_dir=analyzers
cfg_dir=taggers
cfg_dir=discovery_rules
cfg_file=synchronizer_discovery.cfg
packs_dir=packs

#==================================================================================

[...]

#==================================================================================
#======== Global DATA and default properties =========
# You will find global DATA into this directory
cfg_dir=resource.d

# Load default properties for types (like hosts). Do not edit theses files, they are overwritten at every update.
cfg_dir=_default/default_element_properties

#==================================================================================

[...]


#==================================================================================
#======== User parameters customizations =========

# If you need to customise a value in this file, set it in this file
cfg_file=/etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg


# If you need to customise element (host, check, ...) default properties value, set it in this directory
cfg_dir=/etc/shinken-user/configuration/default_element_properties

# For your custom global DTA
cfg_dir=/etc/shinken-user/configuration/global-data

#==================================================================================


Log Externe de Connexion et d'Activité des Utilisateurs

Log de la connexion des utilisateurs

Les paramètres suivants permettent au Synchronizer de créer un fichier de log pour y recenser toutes les tentatives de connexion qu'elles soient réussites ou non ainsi que les déconnexions

Il est possible d'activer un log externe de connexion et d'activité des utilisateurs dans un fichier à part du fichier de log habituel avec ces paramètres

.

Ces paramètres ne sont là que pour avertir l'utilisateur qu'ils peuvent être modifiés dans le fichier /etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg .

noformat
Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#=============== Synchronizer Authentication and Session External Log ====================
                                                       # Log the synchronizer authentication and session history in a file

                                                       # Enable authentication and session log or not.
                                                       # by default: 0 (disabled)
# /!\ Need be change in the file: /etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg
# synchronizer__log_users__enabled=0

                                                       # File use for log authentication and session history
# /!\ Need be change in the file: /etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg
# synchronizer__log_users__file_path=/var/log/shinken/synchronizer/log_users.log

                                                       # Add user name to log.
                                                       # by default: 0 (disabled)
# /!\ Need be change in the file: /etc/shinken-user/configuration/daemons/synchronizers/synchronizer_cfg_overload.cfg
# synchronizer__log_users__add_user_name=0
   
NomTypeUnitéDéfautCommentaire
No Format
synchronizer__log_users__enabled
Booléen
Texte--- 0 Permet d'activer ( valeur "1" ) ou désactiver ( valeur "0" ) les logs d'authentification
et
de
session de
l'interface de configuration.
No Format
synchronizer__log_users__file_path
Texte
Booléen--- /var/log/shinken/synchronizer/log_users.log Définie le fichier utilisé pour écrire les logs.
No Format
synchronizer__log_users__add_user_name
Booléen
Texte--- 0 Permet d'activer ( valeur "1" ) ou désactiver ( valeur "0" ) l'ajout du nom d'utilisateur dans les logs.

Page de Production

Les paramètres suivants permettent de configurer la page de Production

Code Block
languagejs
themeConfluence
title/etc/shinken/synchronizer.cfg
#==================================================================================
#======== Production page =========
                                                       # Timeout for the Arbiter to load a new configuration
#synchronizer__production__apply_new_configuration_timeout=30

#==================================================================================
  



NomTypeUnitéDéfautCommentaire
No Format
synchronizer__production__apply_new_configuration_timeout
Entier positif--- 30 Permet de définir un temps d'attente avant que l'Arbiter soit considéré considérer comme indisponible lors d'une action dans la page de Production ( Vérification de la configuration, Application de la configuration… )

...