Présentation

Principe

Elasticsearch Logs Connector est un outil permettant d'agréger tous les fichiers de logs de Watchdoc au sein d'une base de données ElasticsearchFermé Watchdoc Diag Tool est un outil permettant de rassembler des fichiers utiles au diagnostic d'éventuels dysfonctionnements survenant lors de l'utilisation de Watchdoc.®.

 

Cet outil est particulièrement utile lorsque Watchdoc est installé dans des configurations complexes et notamment lorsque la fonction "interserveur" est activée. Dans ce cas, en effet, les travaux d'impression pouvant être redirigés d'un serveur à l'autre, il est difficile de diagnostiquer la cause d'un dysfonctionnement en raison de la dissémination des fichiers de logs sur les différents serveurs de la configuration. Les rassembler dans une base de données unique permet donc d'optimiser la recherche et, par là, le diagnostic.

 

L'envoi des logs est défini par défaut : enregistrés dans une file d'attente (système de "message queuing"), ces logs sont envoyés systématiquement vers la base de données Elasticsearch® dès que le précédent paquet de logs a été réceptionné. Ces files d'attente peuvent donc être plus ou moins chargées en fonction de l'activité d'impression et des dysfonctionnements survenus.

Prérequis

La mise en œuvre du connecteur requiert les prérequis suivants :

  • Watchdoc (v 5.4 min.) installé sur tous les serveurs ;

  • base de données Elasticsearch® (v. 7.9.0) installée sur le serveur maître ;

  • ouverture du port d'accès au serveur hébergeant Elasticsearch® (9200 par défaut).

Procédure

Accéder au fichier de configuration

Elasticsearch Log Connector s'active et se configure depuis le fichier de configuration Watchdoc.exe.config.xml.

 

Pour activer l'outil :

  1. accédez en tant qu'administrateur au serveur qui héberge Watchdoc ;

  2. rendez-vous dans le dossier C:\Program Files\Doxense\Watchdoc pour y trouver le fichier de configuration Watchdoc.exe.config.xml ;

  3. effectuez une sauvegarde du fichier Watchdoc.exe.config.xml ;

  4. ouvrez le fichier à l'aide d'un éditeur de texte et modifiez-le comme suit.

Configurer Elasticsearch Log Connector

  1. Dans le fichier de configuration Watchdoc.exe.config.xml, ajoutez les clés suivantes :

<add key="dlog/enabled" value="true"/> = la valeur "true" permet d'activer le connecteur ;

<add key="dlog/target" value="elastic"/> = la valeur permet de préciser le type de base de données vers laquelle sont envoyés les logs ;

<add key="dlog/elastic/ssl" value="true"/> = la valeur "true" permet d'activer l'envoi sécurisé des logs par protocole ssl ;

<add key="dlog/elastic/host" value="fqdn_serveur_elasticsearch"/> = la valeur correspond au FQDN du serveur Elasticsearch vers lequel sont envoyés les fichiers de logs ;

<add key="dlog/elastic/port" value="9200"/> = la valeur indique le port d'accès au serveur Elastichsearch (9200 par défaut) ;

<add key="dlog/elastic/index" value="watchdoc"/> (clé optionnelle) = la valeur permet de préciser la provenance du log afin d'en préciser l'indexation ;

<add key="dlog/elastic/type" value="log"/> (clé optionnelle) = la valeur correspond au type du document agrégé dans la base de données. Cette information permet de préciser l'indexation du fichier.

<add key="dlog/elastic/authorization" value="basic"/> = la valeur "basic" indique que l'accès au serveur est soumis à authentification par login et mot de passe : dans ce cas, il est nécessaire de compléter les deux clés suivantes. La valeur "none" indique que l'accès au serveur n'est pas soumis à authentification et les clés suivantes ne sont donc pas traitées ;

<add key="dlog/elastic/ssl" value="login"/> = la valeur "login" précise le login du compte habilité à se connecter au serveur hébergeant Elasticsearch® lorsque l'accès est soumis à authentification ;

<add key="dlog/elastic/password" value="password"/> = la valeur "password" précise le mot de passe du compte habilité à se connecter au serveur hébergeant Elasticsearch® lorsque l'accès est soumis à authentification. 

Dans le cas d'un accès au serveur Elasticsearch® soumis à authentification (authorization="basic" avec indication des login et mot de passe), nous préconisons l'utilisation du SSL qui permet de chiffrer les en-têtes https qui contiennent le login/pass encodé en base64.

  1. Enregistrez le fichier de configuration une fois modifié ;

  2. Redémarrez le service Watchdoc ;

  3. Dans un domaine, la modification du fichier de configuration doit être répétée sur chaque serveur qui héberge l'outil Watchdoc ;

  1. Dans Elasticsearch®, effectuez une recherche sur les fichiers de logs pour vérifier l'efficacité de l'opération d'agrégation.