Données d'audit en ligne et hors ligne (table de données)
Données d'audit en ligne
Lorsque l'implémentation de type Table de données est active, les entrées d'audit en ligne sont conservées en ligne en fonction des valeurs spécifiées pour les paramètres maxEntriesOnlineAuditData et DaysOnline du sous-système d'audit. Les services suivants permettent aux administrateurs de gérer la quantité de données dans la table des données d'audit en ligne :
Les opérations d'archivage et de purge sont déclenchées par les objets planificateur correspondants dans ThingWorx Platform. Ces objets planificateur appellent régulièrement ces services. Vous pouvez configurer les planificateurs en fonction des besoins de votre organisation. Par défaut, ces services s'exécutent quotidiennement. Les messages d'audit en ligne sont conservés dans des fichiers stockés dans le répertoire AuditArchive du référentiel AuditArchiveFileRepository du sous-système d'audit. Vous ne pouvez pas configurer ce référentiel.
 |
Dans le contexte du sous-système d'audit, "hors ligne" signifie que les messages d'audit ne peuvent plus être filtrés ni recherchés et qu'ils ne sont plus stockés dans la table de données.
|
A compter de la version 8.5.0 de ThingWorx Platform, le service ArchiveAuditHistory ne supprime plus les données qui correspondent à l'un des critères de rétention. A la place, un service PurgeAuditData distinct supprime ces données si l'un des critères est respecté.
Reportez-vous à la rubrique Recherche de données d'audit (requêtes, table de données) pour connaître les paramètres facultatifs du service QueryAuditHistory.
Données d'audit hors ligne
Les données d'audit hors ligne fournissent un emplacement de stockage pour les données d'audit auxquelles vous n'avez pas besoin d'accéder souvent, mais que vous souhaitez conserver à des fins administratives. Le service ArchiveAuditHistory copie les données d'audit en ligne sur le stockage hors ligne. Les services suivants permettent aux administrateurs de gérer les données hors ligne :
L'opération d'exportation appelle le service ArchiveAuditHistory, qui copie les données d'audit en ligne demandées depuis le référentiel AuditArchiveFileRepository vers le fichier d'exportation spécifié. L'opération d'exportation traite et traduit les données archivées et les stocke dans le fichier d'exportation spécifié.
Le service CleanUpOfflineAudit s'exécute généralement en fonction d'un planificateur. Il peut également être exécuté manuellement. Vous transmettez au service un paramètre olderThanDate pour spécifier les fichiers archivés à supprimer dans le fichier du référentiel AuditArchiveFileRepository.
Les fichiers hors ligne sont archivés sans localisation. Un service de lecteur hors ligne, appelé ExportAuditData, est disponible pour les récupérer, selon les paramètres régionaux spécifiés. Pour plus d'informations, consultez la rubrique Exportation des données d'audit.
Le diagramme suivant représente la hiérarchie des fichiers d'archive hors ligne. Le paragraphe suivant le diagramme explicite le noeud "Dossier OfflineAudit implémentation active" situé sous FileRepository.
Hiérarchie des archives hors ligne
Dans le diagramme ci-dessus, le noeud "Dossier OfflineAudit implémentation active" représente le répertoire principal du référentiel pour l'implémentation active, à savoir la persistance directe ou la table de données. Si vous avez commencé par l'implémentation de type Table de données et que vous avez ensuite opté pour l'implémentation de type Persistance directe, vous verrez deux répertoires : AuditArchive pour l'implémentation de type Table de données et AuditArchiveDirectPersistence pour l'implémentation de type Persistance directe. Les deux répertoires ont la même structure de sous-répertoires que celle illustrée ci-dessus. Les données d'audit archivées sont conservées lorsque vous passez d'une implémentation à l'autre.
 | Si vous décidez de passer d'une implémentation à l'autre, assurez-vous d'avoir archivé toutes les données d'audit à impérativement conserver avant d'effectuer la bascule. |
Le dossier daté porte la date des messages d'audit qu'il contient et non la date à laquelle l'archive a été exécutée. Comme illustré dans le diagramme ci-dessus, le format utilisé pour le nom du dossier daté est le format AAAA-MM-JJ (ISO 8601), avec un nouveau dossier créé pour chaque jour de messages d'audit. Les "fragments d'audit hors ligne" se trouvent dans un fichier JSON compressé qui contient les messages d'audit de cette date. La taille par défaut des fragments est de 50 000 lignes (taille minimale). Un administrateur système peut modifier la taille par défaut des fragments dans la configuration du sous-système d'audit. Par exemple, l'administrateur système peut spécifier une taille de fragment de 70 000 lignes. Un fichier de fragment compressé existe pour ce nombre de lignes de messages dans le dossier daté. Si chaque entrée d'audit a une taille d'environ 1 Ko, la taille d'un fichier de fragment décompressé ou en mémoire avoisinera les 70 Mo.
Performances et conservation des données
Pour optimiser les performances, il convient de disposer d'un volume équilibré de données d'audit en ligne et hors ligne. Pour cela, le sous-système d'audit permet des opérations d'archivage et de purge.
Utilisez les propriétés suivantes du sous-système pour contrôler la conservation des données d'audit en ligne :
• DaysOnline : lors d'une opération de purge, le paramètre DaysOnline du sous-système d'audit est consulté afin d'identifier les messages d'audit à archiver et à conserver en ligne. Le paramètre DaysOnline spécifie le nombre de jours pendant lesquels les données d'audit doivent être conservées en ligne. Par défaut, la valeur de ce paramètre est de 60.
• maxEntriesOnlineAuditData : (implémentation de type Table de données uniquement) ce paramètre de seuil du sous-système d'audit spécifie le nombre de lignes qu'une table de données d'audit en ligne peut contenir avant qu'une opération de purge ne soit lancée.
Lorsque le planificateur appelle le service ArchiveAuditHistory, la date actuelle est transmise en tant que valeur olderThanDate. Tous les messages d'audit en ligne antérieurs à cette date sont archivés. Ce service ne vérifie pas le paramètre DaysOnline du sous-système d'audit.
Le service PurgeAuditData vérifie la valeur du paramètre DaysOnline du sous-système d'audit afin de déterminer les messages d'audit en ligne à purger et ceux qui doivent rester disponibles en ligne. Avant la suppression des messages d'audit, ce service vérifie s'il existe des messages d'audit en ligne marqués pour suppression qui n'ont pas été archivés. Si tel est le cas, ce service appelle le service ArchiveAuditHistory pour stocker les messages hors ligne. Ces actions permettent de s'assurer que toutes les données supprimées sont archivées avant d'être supprimées.
| | Si la valeur de DaysOnline est 0 et que le service de purge est appelé, toutes les données sont déplacées vers le référentiel hors ligne, puis supprimées du référentiel en ligne. |
Consultez la rubrique Exportation des données d'audit pour en savoir plus sur l'utilisation du service ExportAuditData pour exporter des données d'audit en ligne et hors ligne dans le cadre de l'implémentation de type Table de données.