Journalisation de la configuration
Remarque :
Les enregistrements du journal de configuration s’affichent uniquement en anglais, quelle que soit la langue que vous sélectionnez pour votre compte Citrix Cloud. Les dates et heures associées à ces enregistrements sont au format MM/JJ/AA, exprimées en temps universel coordonné (UTC).
La journalisation de la configuration est une fonctionnalité qui consigne les modifications apportées à la configuration du déploiement Citrix Virtual Apps and Desktops et Citrix DaaS (anciennement Citrix Virtual Apps and Desktops Service), ainsi qu’aux activités administratives dans une base de données de journalisation de Citrix Cloud. Vous pouvez utiliser le contenu consigné pour :
- Diagnostiquer et résoudre les problèmes après que des modifications sont apportées à la configuration. Le journal fournit une arborescence hiérarchique.
- Assister la gestion des modifications et suivre les configurations.
- Signaler les activités administratives.
Dans ce Citrix DaaS, la journalisation de la configuration est toujours activée. Vous ne pouvez pas la désactiver.
Dans Studio, vous pouvez afficher le contenu du journal de configuration, filtré par plages de dates ou par recherche en texte intégral. Vous pouvez également générer un rapport CSV à l’aide de PowerShell. Dans cette console, vous ne pouvez ni modifier ni supprimer le contenu du journal. Vous pouvez utiliser le SDK Remote PowerShell pour planifier la suppression périodique des données du journal.
Mise à jour de la conservation des journaux de configuration DaaS
Afin de maintenir les performances des locataires DaaS, à compter du 9 septembre 2024, la durée de conservation des journaux de configuration sera fixée à 180 jours.
Les journaux datant de plus de 180 jours seront supprimés après le 9 septembre 2024. Alors que nous continuons à augmenter nos limites DaaS pour un seul locataire DaaS, cette mise en œuvre garantit les meilleures performances et la meilleure résilience pour nos clients.
Dans le cadre des meilleures pratiques, nous conseillons à nos clients de disposer d’un mécanisme d’exportation trimestriel. Pour cela, vous pouvez utiliser PowerShell (reportez-vous à la section Générer des rapports). Nous recommandons également à nos clients de planifier la suppression périodique des données (reportez-vous à la section Planifier la suppression périodique des données).
Autorisations requises (voir Administration déléguée) :
- Les administrateurs complets dans Citrix Cloud, ainsi que les administrateurs Cloud et les administrateurs en lecture seule de Citrix DaaS peuvent afficher les journaux de configuration dans Studio.
- Les administrateurs complets et les administrateurs Cloud peuvent également télécharger un rapport CSV d’activités de journalisation à l’aide de PowerShell.
Qu’est-ce qui est journalisé
Les opérations suivantes sont enregistrées :
- Modifications de configuration et activités administratives initiées à partir des consoles Studio et Surveiller
- Scripts PowerShell
- Demandes d’API REST
Remarque :
Vous ne pouvez pas voir les entrées de journal pour les opérations internes de la plateforme Citrix Cloud, telles que la configuration et la gestion de la base de données.
Les exemples de modifications apportées à la configuration journalisées comprennent l’utilisation de (création, modification, suppression des affectations) :
- Catalogues de machines
- Groupes de mise à disposition (y compris la modification des paramètres de gestion de la puissance)
- Rôles et étendues de l’administrateur
- Ressources et connexions de l’hôte
- Stratégies Citrix au travers de Studio
Exemples de modifications administratives journalisées :
- Gestion de la puissance d’une machine virtuelle ou d’un bureau utilisateur
- Fonctions de gestion ou de surveillance envoyant un message à un utilisateur
Les opérations suivantes ne sont pas enregistrées. (Beaucoup ne sont pas disponibles pour les administrateurs clients.)
- Opérations automatiques telles que la mise sous tension de la gestion du pool de machines virtuelles.
- Actions de stratégie implémentées au travers de la console de gestion des stratégies de groupe (GPMC). Utilisez les outils Microsoft pour afficher des journaux de ces actions.
- Les modifications effectuées via le Registre ou à partir de sources autres que Studio, Monitor ou PowerShell.
Afficher le contenu du journal de configuration
Pour afficher le contenu du journal de configuration, procédez comme suit :
- Connectez-vous à Citrix Cloud.
- Dans la vignette DaaS, cliquez sur Gérer.
- Sélectionnez Journalisation dans le panneau gauche, puis cliquez sur l’onglet Événements.
Par défaut, l’affichage dans le panneau central affiche le contenu du journal par ordre chronologique (la plus récente des entrées en premier), en les séparant par date. Vous pouvez :
- Trier l’affichage par en-tête de colonne.
- Filtrer l’affichage en spécifiant un intervalle de jours ou une période personnalisée, ou en saisissant du texte dans la zone de recherche. Pour revenir à l’affichage standard après la recherche, désactivez le texte dans la zone Rechercher.
- Choisissez les colonnes à afficher à l’écran en sélectionnant l’icône Colonnes à afficher dans le coin supérieur droit du tableau. Par exemple, pour afficher l’adresse IP utilisée par l’administrateur pour accéder au DaaS, cliquez sur l’icône et ajoutez la colonne IP client.
Caractéristiques d’affichage :
- Les opérations de haut niveau créées lors de la gestion et de la surveillance sont répertoriées dans le volet central supérieur. Une opération de haut niveau se traduit par un ou plusieurs appels de service et de SDK PowerShell, qui sont des opérations de bas niveau. Lorsque vous sélectionnez une opération de haut niveau dans le panneau central supérieur, le panneau inférieur affiche les opérations de bas niveau.
- Si vous créez une opération de bas niveau dans PowerShell sans spécifier une opération de haut niveau parente, la journalisation de la configuration crée une opération de haut niveau de substitution.
- Si une opération échoue avant la fin de l’opération, l’opération de journalisation peut ne pas être effectuée dans la base de données. Par exemple, un enregistrement de début n’a pas d’enregistrement de fin correspondant. Dans de tels cas, le journal indique qu’il manque des informations. Lorsque vous affichez les journaux basés en fonction de plages de temps, les journaux incomplets sont affichés si les données dans les journaux correspondent aux critères. Par exemple, si vous demandez les journaux des cinq derniers jours et qu’un journal avec une heure de début dans les cinq derniers jours n’a pas de date de fin, il est inclus.
- Rappel : vous ne pouvez pas voir les entrées de journal pour les opérations internes de la plateforme Citrix Cloud, telles que la configuration et la gestion de la base de données.
Afficher les tâches liées aux opérations de catalogue de machines
Pour afficher les tâches liées aux opérations de catalogue de machines, accédez à Journalisation > Tâches. L’onglet Tâches affiche uniquement les tâches liées aux catalogues créés via Machine Creation Services (MCS) ou Provisioning Services (PVS). Plus précisément, vous verrez les tâches associées aux opérations suivantes du catalogue de machines :
- Créer des catalogues
- Cloner des catalogues
- Ajouter des machines
- Supprimer des machines
- Mettre à jour un catalogue (mettre à jour des images ou des machines)
- Restaurer des mises à jour de machines
Conseil :
L’onglet Tâches affiche uniquement les tâches liées aux modifications du schéma de provisioning (création ou modification d’un schéma de provisioning).
Une tâche peut être dans l’état suivant :
- Terminé
- Non démarré
- En cours d’exécution
- Annulé
- Échec
- Inconnu
Pour annuler une tâche en cours d’exécution, sélectionnez-la, puis cliquez sur Annuler. L’annulation prend un certain temps.
Voici des exemples de tâches consignées :
- Mise à jour de l’image terminée pour un certain catalogue
- Erreur lors de la mise à jour de l’image pour un certain catalogue
- Mise à jour de l’image annulée pour un certain catalogue
- Provisionnement de machines virtuelles sur un certain catalogue
- Suppression de machines virtuelles d’un certain catalogue
- Création d’un certain catalogue
Par défaut, l’affichage dans le panneau central affiche les tâches consignées par ordre chronologique (la plus récente des entrées en premier), en les séparant par date. Vous pouvez trier l’affichage par en-tête de colonne. Pour effacer les tâches terminées, cliquez sur Effacer les tâches terminées sous l’onglet Tâches. Pour choisir les colonnes à afficher à l’écran, sélectionnez l’icône Colonnes à afficher dans le coin supérieur droit du tableau.
Afficher les journaux d’API
Pour afficher les journaux des API REST, accédez à Journalisation > API. L’onglet API affiche les demandes d’API REST effectuées pendant une certaine période.
Prenez en compte les informations suivantes :
- Les journaux d’API REST sont effacés une fois que vous êtes déconnecté de la console. (Ils sont également effacés si vous actualisez la fenêtre de votre navigateur.)
- Les demandes d’API correspondant à toutes les opérations de la console qui entraînent des appels d’API sont affichées dans l’onglet API.
- Les demandes d’API sont affichées par ordre chronologique (entrées les plus récentes en premier), séparées par date. Le nombre maximal de demandes d’API affichées est de 1 000.
Afficher les journaux PowerShell
Pour afficher les commandes PowerShell correspondant aux actions de l’interface utilisateur que vous avez effectuées au cours de la journée, accédez à l’onglet Journalisation > PowerShell.
Associer des métadonnées aux journaux de configuration
Vous pouvez joindre des métadonnées aux journaux de configuration en associant une paire name-value appelée MetadataMap aux enregistrements des journaux.
Remarque :
- Vous ne pouvez associer des métadonnées qu’à des objets d’opération de haut niveau.
- Les métadonnées sont associées aux enregistrements existants au moment de l’exécution.
Définir les métadonnées
Exécutez la commande PowerShell Set-LogHighLevelOperationMetadata pour associer un enregistrement de journal à MetadataMap.
Set-LogHighLevelOperationMetadata accepte les paramètres suivants :
- ID : ID de l’opération de haut niveau.
-
InputObject : opérations de haut niveau auxquelles vous ajoutez les métadonnées. Il s’agit d’une alternative au paramètre
Iddans lequel un objet d’opération de haut niveau ou une liste d’objets est transmis à la commande PowerShell. -
Name : nom de propriété des métadonnées à ajouter. La propriété doit être unique pour l’opération de haut niveau spécifiée. La propriété ne peut contenir aucun des caractères suivants :
()\/;:#.*?=<>|[]"' - Value : valeur de la propriété.
-
Map : dictionnaire des paires (name, value) pour les propriétés. Il s’agit d’une alternative à la définition des métadonnées utilisant les paramètres
-Nameet-Value.
Par exemple, pour associer les métadonnées à tous les enregistrements de journal de haut niveau portant l’ID 40, exécutez la commande PowerShell suivante :
Get-LogHighLevelOperation – Id 40 | Set-LogHighLevelOperationMetadata -Name A -Value B
Pour associer les métadonnées à l’enregistrement de haut niveau avec l’utilisateur abc@example.com, exécutez la commande PowerShell suivante :
Get-LogHighLevelOperation – User `abc@example.com` | Set-LogHighLevelOperationMetadata -Name C -Value D
Récupérer les enregistrements à l’aide des métadonnées
Exécutez les commandes PowerShell suivantes pour utiliser les métadonnées associées afin de récupérer les enregistrements de journal :
-
Recherche par clé et par valeur :
Get-LogHighLevelOperation -Metadata "Key:Value" -
Recherche par valeur et n’importe quelle clé :
Get-LogHighLevelOperation -Metadata "*:Value" -
Recherche par clé et par n’importe quelle valeur :
Get-LogHighLevelOperation -Metadata "Key:*"
Supprimer les métadonnées
Exécutez la commande PowerShell Remove-LogHighLevelOperationMetadata pour supprimer les métadonnées associées.
Remove-LogHighLevelOperationMetadata utilise les paramètres suivants :
- ID : ID de l’opération de haut niveau.
-
InputObject : opérations de haut niveau auxquelles vous ajoutez les métadonnées. Il s’agit d’une alternative au paramètre
Id` dans lequel un objet d’opération de haut niveau ou une liste d’objets est transmis à la commande PowerShell. - Name : nom de propriété des métadonnées à supprimer. Définissez cette valeur sur $null pour supprimer toutes les métadonnées de l’objet spécifié.
- Map : dictionnaire des paires (name, value) pour les propriétés. Il peut s’agir d’une table de hachage (créée avec @{“name1” = “val1”; “name2” = “val2”}) ou d’un dictionnaire de chaînes (créé avec new-object “System.Collections.Generic.Dictionary[String, String]”). Les propriétés dont les noms correspondent aux clés du dictionnaire sont supprimées.
Générer des rapports
Pour générer un rapport CSV ou HTML contenant des données de journal de configuration, utilisez les applets de commande PowerShell pour le service ConfigLogging dans le SDK Remote PowerShell Citrix Virtual Apps and Desktops. Pour plus de détails, consultez :
Planifier la suppression périodique des données
Utilisez le SDK Remote PowerShell pour spécifier la durée de conservation des données dans la base de données de journalisation de la configuration. (Cette fonctionnalité n’est pas disponible dans Studio.) Dans Citrix DaaS, vous devez disposer d’un accès complet.
Dans l’applet de commande Set-LogSite, le paramètre -LoggingDBPurgeDurationDays spécifie combien de jours les données de la base de données de journalisation de la configuration sont conservées avant d’être supprimées automatiquement.
- Par défaut, la valeur de ce paramètre est 0. Une valeur zéro signifie que les données de la base de données de journalisation de la configuration ne sont jamais supprimées automatiquement.
- Lorsque vous définissez une valeur différente de zéro, la base de données est vérifiée une fois toutes les 120 minutes. Les données antérieures à la période de rétention sont supprimées.
Utilisez Get-LogSite pour afficher la valeur actuelle du paramètre.
Différences par rapport à Citrix Virtual Apps and Desktops sur site
Si vous avez déjà utilisé la journalisation de la configuration dans Virtual Apps and Desktops sur site, la version Citrix Cloud présente plusieurs différences. Dans Citrix Cloud :
- La journalisation de la configuration est toujours activée. Vous ne pouvez pas la désactiver. La journalisation obligatoire n’est pas disponible.
- Vous ne pouvez pas modifier l’emplacement de la base de données de journalisation de la configuration, car la base de données est gérée dans la plate-forme Citrix Cloud.
- Les affichages du journal de configuration n’incluent pas les opérations et les activités effectuées sur la plate-forme Citrix Cloud.
- PowerShell est votre seul choix pour créer un rapport CSV ou HTML des opérations consignées. Dans le produit sur site, les rapports peuvent être générés à partir de Citrix Studio ou de PowerShell.
- Vous ne pouvez pas supprimer le contenu du journal de configuration.
Dans cet article
- Mise à jour de la conservation des journaux de configuration DaaS
- Qu’est-ce qui est journalisé
- Afficher le contenu du journal de configuration
- Afficher les tâches liées aux opérations de catalogue de machines
- Afficher les journaux d’API
- Afficher les journaux PowerShell
- Associer des métadonnées aux journaux de configuration
- Générer des rapports
- Planifier la suppression périodique des données
- Différences par rapport à Citrix Virtual Apps and Desktops sur site