Nettoyage des archives d'audit
Lorsque l'audit est activé, vous devez surveiller l'espace disque pour déterminer si un nettoyage du référentiel AuditArchiveFileRepository du sous-système d'audit est nécessaire. Les mesures suivantes peuvent faciliter votre décision :
AuditArchiveDiskSpaceUsed (en Mo) : espace disque utilisé par le référentiel d'archivage
AuditArchiveFreeDiskSpace (en Mo) : espace disque disponible
Deux objets planificateur sont applicables au service ExportAuditData :
AuditArchiveCleanupScheduler : par défaut, planifie une tâche le dernier vendredi de chaque mois à 18 heures. La tâche appelle le service CleanUpOfflineAudit et supprime du référentiel AuditArchiveFileRepository toutes les données d'audit hors ligne dont l'ancienneté est supérieure à la propriété DaysToArchive de cet objet planificateur. Vous pouvez modifier cette propriété dans ThingWorx Composer. Sa valeur par défaut est de 180 jours. Il est également possible d'appeler manuellement le service CleanUpOfflineAudit. Dans ce cas, le service prend en entrée une date et supprime du référentiel toutes les données d'audit qui y sont antérieures.
AuditArchiveCleanupNotificationScheduler : avertit les utilisateurs de l'exécution du service de nettoyage. Par défaut, cet objet planificateur est déclenché le dernier vendredi de chaque mois à 18 heures. Les utilisateurs abonnés à l'événement qu'il déclenche sont avertis que le service de nettoyage sera exécuté à 18 h (heure par défaut d'exécution de la tâche planifiée par l'objet AuditArchiveCleanupScheduler). A l'instar de la planification du service de nettoyage, vous pouvez modifier le jour et/ou la fréquence d'exécution de ce service de notification. Vous pouvez également vous inscrire à l'événement et ajouter votre propre logique dans un script que vous souhaitez exécuter à partir de l'événement. Consultez la section Abonnement à l'événement ci-après pour plus de détails.
Le service de nettoyage CleanUpOfflineAudit prend olderThanDate en entrée. Cet argument est de type DateTime et suit le format YYYY-MM-DD. Le service supprime les entrées d'audit du stockage hors ligne qui sont antérieures à la date spécifiée. Vous pouvez également exécuter ce service manuellement.
A la fin de l'opération, le service de nettoyage fournit des informations sur les répertoires supprimés et, le cas échéant, ceux dont la suppression a échoué. Notez que l'échec de suppression d'un fichier ou d'un répertoire n'interrompt pas le processus de nettoyage. Le service ignore le répertoire problématique et passe au suivant.
Supposons par exemple que le service est appelé avec la date 2017-06-07 et que le répertoire racine du référentiel des fichiers d'archivage d'audit contient les sous-répertoires suivants :
Voici le référentiel à l'issue du nettoyage :
Seuls les administrateurs sont habilités à appeler le service de nettoyage. Dans le cas d'un utilisateur non-administrateur, un administrateur doit lui accorder les permissions correspondantes à l'aide d'un remplacement de service. Pour en savoir plus sur les remplacements de service, consultez la rubrique Remplacements de service dans la section Sécurité de ce Centre d'aide.
Lorsque l'opération se déroule avec succès, un message indiquant la quantité d'espace libérée est consigné dans le journal du serveur. Dans le cas contraire, un message d'erreur indiquant le motif de l'échec est renvoyé.
Bonnes pratiques pour la définition de la durée de conservation hors ligne des données
Si le reporting de mesure est activé, les données concernant le sous-système d'audit et son référentiel des fichiers d'archivage d'audit sont accessibles dans ThingWorx Composer. Pour accéder aux mesures, sélectionnez Surveillance > Sous-système. Vous pouvez consulter la liste des mesures dans la rubrique Mesure des activités d'audit. Comme indiqué ci-avant, les mesures suivantes permettent de déterminer si un nettoyage des données d'audit archivées du référentiel est requis :
AuditArchiveDiskSpaceUsed (en Mo) : espace disque utilisé par les données archivées dans le référentiel AuditArchiveFileRepository
AuditArchiveFreeDiskSpace (en Mo) : espace disque disponible
Si l'espace disque disponible est faible, il est recommandé de nettoyer le référentiel dès que possible en appelant manuellement le service de nettoyage, puis en spécifiant une date de début utilisée par le service pour supprimer tous les fichiers et répertoires antérieurs à cette date. Pensez également à diminuer la valeur de la propriété DaysToArchive afin de toujours disposer de l'espace disque requis pour votre environnement.
Abonnement à l'événement
L'objet AuditArchiveCleanupNotificationScheduler déclenche un événement appelé AuditCleanupNotification et avertit les abonnés d'une opération imminente de nettoyage de fichiers. Vous pouvez vous inscrire à l'événement et ajouter votre propre logique dans un script que vous souhaitez exécuter à partir de l'événement.
La tâche associée à l'objet AuditArchiveCleanupScheduler utilise une propriété DaysToArchive. Par défaut, la valeur de cette propriété est de 180 jours (six mois) et peut être modifiée dans ThingWorx Composer. Tous les mois, la tâche planifiée est exécutée et nettoie toutes les données antérieures à la valeur spécifiée pour la propriété DaysToArchive. Vous pouvez également modifier la fréquence d'appel automatique du service dans Composer.