Déploiement du module d'audit

Modifié par jhurst le 2021/11/15 09:22

Ce document présente l'installation du module d'audit intégré à DigDash Enterprise. Ce module permet à un administrateur du système de connaître la liste des cubes de données et des flux et l'historique des sessions utilisateurs.

Installation du module

Le module d'audit se présente sous la forme d'un fichier zip compatible avec le système de restauration de sauvegardes de DigDash Enterprise. Voici comment déployer ce module :

  1. Se connecter à la page d'accueil de DigDash Enterprise avec un navigateur web (par défaut http://localhost:8080/adminconsole)
  2. Cliquer sur Configuration, puis Gestion des sauvegardes et Restauration
  3. Si ce n'est pas déjà fait, se connecter avec l'administrateur du système DigDash Enterprise
  4. Cliquer sur le bouton Choisir un fichier...
  5. Dans le sélecteur de fichier, naviguer jusqu'au dossier <Répertoire d'installation de DigDash Enterprise>/add-ons/ddaudit et choisir le fichier ddaudit_module.zip
  6. Cliquer sur le bouton Charger
  7. Valider les options d'import en cliquant sur le bouton Valider
  8. Redémarrer le serveur

A la fin de l'opération d'import, le système DigDash Enterprise est enrichi d'un nouveau rôle DDAudit contenant :

  • Des modèles de données pré-définis permettant de créer des visualisations sur les données d'audits
  • Des flux pré-définis : liste des cubes, listes des flux et listes des sessions utilisateurs
  • Un tableau de bord affichant les données d'audits

Accès aux données d'audit DigDash Enterprise

Afin de visualiser ces informations il faut ajouter le rôle DDAudit à votre administrateur DigDash Enterprise ou tout autre utilisateur que vous souhaitez pour cette tâche.

Depuis la page État du serveur, démarrez les services d'audit que vous souhaitez utiliser (service d'audits des sessions, cubes et flux).

Des rapports prédéfinis sont directement accessibles dans la page État du serveur et dans le Portefeuille d'information de l'utilisateur.

Vous pouvez également créer de vos propres flux basés sur les modèles de données, voire de nouveaux modèles de données sur la base de données d'audit.

Gérer les fichier de la base de données DDAudit

Migration depuis une version précédente du module d'audit

Si vous aviez déployé le module d'audit dans une version précédente de DigDash Enterprise (antérieurement à la build 2014B0603), le nom de la base de données H2 était alors DDAudit.

A partir de la version 2014B0603 ce nom est changé par défaut en DDAudit_<domaine DDE> pour s’accommoder d'un déploiement multi-domaines sur le même serveur. Suite à ce changement, les données d'audit précédentes ne sont plus accessibles dans la nouvelle version de DigDash Enterprise.

Pour les récupérer il y a deux scénarios de migration possibles (au choix):

  • Option 1 (recommandée) : En renommant l'ancienne base DDAudit en DDAudit_<domaine DDE> (par défaut le nom de domaine DDE est ddenterpriseapi),
  • Option 2 : En référençant l'ancien nom DDAudit dans la nouvelle version de DigDash Enterprise (modification de digdash.properties).

Option 1 (recommandée) : Renommage de l'ancienne base de données DDAudit

Cette option est à choisir si vous n'avez pas modifié les modèles de données du rôle DDAudit, ou si vous ne souhaitez pas conserver ces modifications. La modification de flux et/ou de pages de tableaux de bords d'audit n'est pas significative pour cette option.

Procédure de migration pour l'option 1 :

  1. Arrêter les serveurs DigDash Enterprise
  2. Trouver les fichiers DDAudit.h2.db et DDAudit.trace.db sur la machine serveur :
  • Sous Windows ces fichiers peuvent se trouver dans le répertoire d'installation de DigDash Enterprise si le serveur est lancé manuellement via start_servers.bat, ou <Windows>/System32 si le serveur est lancé en tant que service Windows.
  • Sous Linux, selon la configuration du système, ces fichiers peuvent se trouver dans le répertoire d'installation de votre Tomcat (souvent au même endroit que les logs).
  1. Traiter ces fichiers comme indiqué ci-dessous :
  • Copier et renommer DDAudit.h2.db en DDAudit_<domaine DDE>.h2.db (exemple : DDAudit_ddenterpriseapi.h2.db)
  • Copier et renommer DDAudit.trace.db en DDAudit__<domaine DDE>.trace.db (exemple : DDAudit_ddenterpriseapi.trace.db)
  1. Démarrer les serveurs DigDash Enterprise
  2. Déployer le nouveau module d'audit (chapitre I) afin que les modèles de données d'audit référencent la nouvelle base de données d'audit.

Option 2 : Modification de digdash.properties pour pointer sur l'ancienne base de données DDAudit

Voir le chapitre "Externalisation des paramètres dans un fichier properties" pour effectuer la manipulation suivante.

Cette option est à choisir si vous avez modifié les modèles de données du rôle DDAudit, et que vous souhaitez conserver ces modifications. La modification de flux et/ou de pages de tableaux de bords d'audit n'est pas significative pour cette option. Attention, si vous avez plusieurs domaines ddenterpriseapi_xxx sur le même Tomcat, il est conseillé de ne faire cette migration que sur un seul domaine car la base de données DDAudit ne peut pas être utilisée par plusieurs domaines en même temps.

Procédure de migration pour l'option 2 :

  1. Arrêter le serveur DigDash Enterprise
  2. Ouvrir en édition le fichier <Répertoire d'installation de DigDash Enterprise>/digdash.properties.
    • Changer la valeur du paramètre <nom du domaine>.audit.db.url
      de jdbc:h2:DDAudit_${server.DomainName};AUTO_SERVER=TRUE
      en jdbc:h2:DDAudit
  3. Démarrer le serveur DigDash Enterprise

Changer l'emplacement des fichiers de base de données DDAudit

Par défaut, les fichiers de la base de données DDAudit sont stockés dans le répertoire de travail de Tomcat. Dans quelques configurations ce chemin peut ne pas être le répertoire d'installation de DigDash Enterprise.

Par exemple, sur Linux le répertoire de travail de Tomcat peut être le dossier d'installation de Tomcat (ex: /var/lib/tomcatX), et les droits d'utilisateurs peuvent empêcher le serveur d'écrire et/ou de modifier des fichiers dans ce répertoire. Dans ce cas DDAudit ne fonctionnera pas.

Un autre exemple est sous Windows, lorsque Tomcat est démarré en tant que service, les fichiers de base de données DDAudit peuvent se trouver dans le répertoire Windows/system32.

Voir le chapitre "Externalisation des paramètres dans un fichier properties" pour effectuer la manipulation suivante.

Vous pouvez changer l'emplacement des fichiers de base de données DDAudit selon la procédure suivante :

  1. Arrêter le serveur DigDash Enterprise
  2. Ouvrir en édition le fichier <Répertoire d'installation de DigDash Enterprise>/digdash.properties.
    • Changer la valeur du paramètre audit.db.url
      de jdbc:h2:DDAudit_${server.DomainName};AUTO_SERVER=TRUE
      en jdbc:h2:file:/home/audit/DDAudit_${server.DomainName};AUTO_SERVER=TRUE (attention au « file: » inséré en début d’URL)
  3. Vérifier que le dossier spécifié existe et déplacer tous les fichiers existants DDAudit*.db vers le nouvel emplacement
  4. Démarrer le serveur DigDash Enterprise

Note : Les paramètres audit.db.url, audit.db.user, audit.db.password et audit.db.tcpServer peuvent également être spécifiés sous la forme de paramètres de lancement de la JVM, par exemple en ajoutant dans la variable JAVA_OPTS (setenv.bat, setenv.sh…) ou dans catalina.properties :
JAVA_OPTS=[…] -Daudit.db.url=jdbc:h2:file:/home/DDAudit;AUTO_SERVER=TRUE [...]

Une alternative est de changer la valeur du paramètre h2.baseDir, qui change globalement le comportement des bases H2 (DDAudit, mais aussi DDComments) :

  1. Arrêter le serveur DigDash Enterprise
  2. Chercher et éditer le fichier catalina.properties sur le serveur (ex : <DDE Install>/apache-tomcat/conf/catalina.properties sur une installation Windows)
  3. Ajouter la ligne suivante : h2.baseDir=/le/nouveau/chemin

Note : Ce chemin peut être relatif au répertoire de travail de Tomcat (ex : h2.baseDir=./db)

  1. Vérifier que ce dossier existe et déplacer tous les fichiers existants DDAudit*.db vers le nouvel emplacement
  2. Démarrer le serveur DigDash Enterprise