Chargement des journaux AOT depuis les composants principaux CVAD

À partir de CVAD 2507 CU1 et CVAD 2511, les journaux AOT sont collectés à partir de tous les composants applicables. Les composants pris en charge incluent DDC, StoreFront, Citrix Director, Windows VDA, Linux VDA, Mac VDA, License Server, FAS, Cloud Connector, PVS, WEM, Session Recording, Citrix Workspace UI et Citrix Gateway.

Configuration centralisée du transfert des journaux via Citrix Web Studio pour CVAD sur site

Citrix Web Studio fournit un emplacement centralisé pour la configuration du transfert des journaux Always-on Tracing (AOT) sur l’ensemble du site. Ce paramètre définit l’endroit où les journaux AOT sont envoyés et propage automatiquement la configuration aux composants pertinents de l’environnement.

Lorsque vous configurez le serveur de journaux dans Web Studio :

  • La configuration est écrite dans la base de données du site.
  • Les Delivery Controllers récupèrent les paramètres mis à jour et les distribuent aux VDA dans les groupes de mise à disposition sélectionnés.
  • Les VDA utilisent la configuration reçue pour transférer leurs journaux AOT vers le serveur de journaux spécifié.
  • StoreFront qui participe à la journalisation AOT reçoit les détails nécessaires par le même mécanisme centralisé.
  • Director utilise l’AuthKey fournie et les détails du serveur de journaux pour interroger et afficher les journaux AOT pour la surveillance et le dépannage.

Cette approche centralisée élimine la nécessité de configurer chaque composant individuellement. Vous configurez les détails du serveur de journaux une seule fois dans Web Studio, et Citrix propage automatiquement la configuration sur l’ensemble du site.

Voici la liste des composants qui recevront les détails du serveur de journaux une fois qu’il est configuré dans Web Studio :

  • Citrix Director/Monitor
  • Citrix Delivery Controller
  • Windows VDA
  • VDA Linux
  • VDA Mac
  • StoreFront
  • Agent d’enregistrement de session
  • CWAs

Pour configurer les paramètres du serveur de journaux pour l’environnement sur site

Paramètres du serveur de journaux AOT

  1. Connectez-vous à Web Studio et sélectionnez Paramètres dans le volet gauche.
  2. Dans la vignette Serveur de journaux, sélectionnez Ajouter si aucun serveur de journaux n’est configuré.
  3. Sur la page Serveur de journaux, activez Activer le transfert des journaux vers le serveur de journaux.
  4. Saisissez l’adresse du serveur de journaux et le port. Les VDA et les Delivery Controllers utilisent ces informations pour transférer les journaux AOT.

    Remarque :

    1. Si vous utilisez l’appliance Citrix Connector pour déployer le serveur de journaux, assurez-vous que seul le port 443 est configuré.

    2. La mise à jour de l’adresse et du port du serveur de journaux dans Citrix Studio fonctionne initialement, mais si vous revenez aux paramètres et modifiez les détails du serveur de journaux sans ressaisir la clé d’authentification, l’espace réservé de la clé d’authentification devient vide après l’enregistrement, même si l’opération semble réussie. Cela entraîne une configuration manquante ou invalide dans Director et Monitor. Pour contourner ce problème, ressaisissez et validez toujours la clé d’authentification chaque fois que vous modifiez les paramètres du serveur de journaux, jusqu’à ce que ce problème soit résolu.

  5. Choisissez les composants qui transfèrent les journaux :

    1. Inclure les Delivery Controllers : Envoie les journaux AOT de tous les Delivery Controllers.

    2. Sélectionner les groupes de mise à disposition : Envoie les journaux des VDA dans les groupes de mise à disposition sélectionnés.

      • Tous les groupes de mise à disposition : Envoie les journaux de tous les VDA.
      • Sélectionner des groupes de mise à disposition spécifiques : Choisissez les groupes de mise à disposition individuels à inclure.
  6. Saisissez l’AuthKey générée sur le serveur de journaux. Le dDirector utilise cette clé pour s’authentifier et récupérer les journaux.
  7. Sélectionnez Enregistrer pour appliquer la configuration.

Pour modifier une configuration existante

Pour mettre à jour le serveur de journaux ou modifier la portée de la journalisation, accédez à Paramètres > Serveur de journaux et sélectionnez Modifier.

Configurer les paramètres du serveur de journaux pour l’environnement Citrix DaaS/Cloud via les paramètres DaaS

Always On Tracing (AOT) est pris en charge pour les déploiements sur site (CVAD) et Citrix DaaS (cloud). Cependant, le comportement de collecte des journaux diffère selon l’emplacement d’hébergement des composants.

Après avoir installé et configuré le serveur de journaux AOT (sur Linux, Windows ou Connector Appliance), effectuez les étapes suivantes pour activer le transfert des journaux vers le serveur de journaux dans les paramètres Citrix DaaS pour les déploiements cloud :

Paramètres du serveur de journaux AOT 1

Citrix Web Studio pour DaaS (paramètres DaaS) fournit un emplacement centralisé pour configurer le transfert des journaux Always-on Tracing (AOT) pour les sites gérés dans le cloud. Cette configuration détermine où les journaux AOT sont envoyés et contrôle quels VDA participent au transfert des journaux. Monitor utilise ces paramètres pour récupérer et afficher les journaux à des fins de dépannage.

  1. Connectez-vous à Web Studio pour DaaS (Paramètres DaaS) et sélectionnez Paramètres dans le volet gauche.
  2. Dans la vignette Serveur de journaux, sélectionnez Ajouter si aucun serveur de journaux n’est actuellement configuré.
  3. Sur la page Serveur de journaux, entrez l’adresse du serveur de journaux et le port. Les VDA utilisent ces informations pour transférer les journaux AOT vers le serveur.
  4. Définissez les VDA qui transfèrent les journaux :

    1. Sélectionnez Sélectionner des groupes de mise à disposition pour contrôler la portée.
    2. Tous les groupes de mise à disposition (par défaut) transfèrent les journaux de tous les VDA du site.
    3. Pour cibler des VDA spécifiques, sélectionnez Sélectionner des groupes de mise à disposition spécifiques, puis choisissez les groupes de mise à disposition que vous souhaitez inclure.

    Remarque :

    Si vous utilisez le Citrix Connector Appliance pour déployer le serveur de journaux, assurez-vous que seul le port 443 est configuré.

  5. Sélectionnez la zone (emplacement des ressources) où le serveur de journaux est déployé.
  6. Entrez la clé d’authentification (Authkey) générée par le serveur de journaux. Monitor utilise cette clé pour s’authentifier et récupérer les journaux à afficher.
  7. Sélectionnez Enregistrer pour appliquer la configuration.

Configuration du transfert de journaux pour d’autres composants

Configurer le téléchargement des journaux AOT pour le serveur d’enregistrement de session

Vous pouvez configurer le serveur d’enregistrement de session pour qu’il télécharge les journaux AOT vers un serveur de journaux central en exécutant la commande PowerShell suivante sur la machine du serveur d’enregistrement de session :

#Enable - run following command in Session Recording Server PowerShell
Enable-CitrixAOTUpload -AotDataStoreEndpoint <server address>:<server port> -Role SessionRecording

#Disable - run following command in Session Recording Server PowerShell
Disable-CitrixAOTUpload
<!--NeedCopy-->

Configurer le téléchargement des journaux AOT pour FAS

Vous pouvez configurer FAS pour qu’il télécharge les journaux AOT vers un serveur de journaux central en exécutant la commande PowerShell suivante sur le serveur FAS :

#Enable - run following command in FAS PowerShell
Enable-CitrixAOTUpload -AotDataStoreEndpoint <server address>:<server port> -Role FAS

#Disable - run following command in FAS PowerShell
Disable-CitrixAOTUpload
<!--NeedCopy-->

Configurer le téléchargement des journaux AOT pour PVS

Vous pouvez configurer PVS pour télécharger les journaux AOT vers un serveur de journaux central en exécutant la commande PowerShell suivante sur le serveur PVS :

#Enable - run following command in PVS PowerShell
Enable-CitrixAOTUpload -AotDataStoreEndpoint <server address>:<server port> -Role PVS

#Disable - run following command in PVS PowerShell
Disable-CitrixAOTUpload
<!--NeedCopy-->

Remarque :

Si vous avez plusieurs serveurs PVS, exécutez la commande pour activer ou désactiver le téléchargement des journaux AOT sur chacun d’eux.

Téléchargement des journaux AOT pour le serveur de licences

  • L’URL du serveur de journaux doit être mise à jour dans le fichier de configuration SLS, qui se trouve à l’emplacement “C:\Program Files (x86)\Citrix\Licensing\WebServicesForLicensing\SimpleLicenseServiceConfig.xml” avec la balise XML “AotServerURL”

Exemple :

<AotServerURL>https://10.110.249.168:8443/ctxlogserver/UploadCitrixLogStream</AotServerURL>
<!--NeedCopy-->
  • Le serveur de licences télécharge automatiquement et périodiquement les journaux vers le serveur AOT.

Configurer le téléchargement des journaux AOT pour Citrix Connector

Pour collecter les journaux Cloud Connector dans le serveur de journaux AOT, les exigences suivantes s’appliquent :

  • Cloud Connector doit être en version 6.157.0.19398 ou ultérieure.

  • Dans les déploiements DDC Cloud, les détails de configuration du serveur de journaux sont automatiquement synchronisés avec le registre avec la version de mai (DDC 128), et aucune configuration manuelle n’est requise

  • Dans les déploiements hybrides (DDC sur site), une configuration manuelle du registre est requise pour activer la collecte des journaux. Créez les entrées de registre suivantes sur la machine Cloud Connector :

Chemin d’accès: HKLM\Software\Citrix\ConfigSyncService

Entrées:

  • LogServerEnabled (REG_DWORD) = 1

  • LogServerEndpoint (REG_SZ) = <https://<logserver-fqdn>:<port>>

Configurer le téléchargement des journaux AOT pour les applications Citrix Workspace

Citrix permet aux clients de l’application Citrix Workspace de télécharger automatiquement les journaux de diagnostic vers le serveur de journaux centralisé. Cette fonctionnalité améliore l’efficacité du dépannage en offrant aux administrateurs un accès immédiat aux informations de diagnostic côté client sans nécessiter de collecte manuelle des journaux. Les AOT côté client seront automatiquement téléchargés, et cela se déclenche lorsque la fonctionnalité AOT est activée dans l’ensemble de l’environnement CVAD, et lorsqu’un utilisateur lance une ressource.

Configuration système requise

  • Citrix Virtual Apps and Desktops 2511 ou CVAD 2507 CU1 et versions ultérieures
  • Application Citrix Workspace 2511 ou CWA 2507.1 CU1 et versions ultérieures
  • Assurez-vous que la version requise de l’application Citrix Workspace (CWA) sélectionnée est installée. Pour plus d’informations, consultez Versions prises en charge

Configurer le téléchargement des journaux AOT pour NetScaler

  • Connectez-vous en SSH à l’interface de ligne de commande (CLI) de NetScaler, puis accédez au shell NetScaler en exécutant la commande « shell ».
  • Accédez au répertoire /var/analytics_conf

    cd /var/analytics_conf
    <!--NeedCopy-->
    
  • Générez le fichier de schéma en exécutant un script Python interactif « python {auditlog_schema_generator_for_hec_export.py} ». Le fichier de schéma définit les en-têtes HTTP (Auth-token, User-Agent, etc.) et les attributs de charge utile (Rôle, IP de la machine, etc.).

Extrait de la sortie générée par ce script

root@Raju-adc2# python auditlog_schema_generator_for_hec_export.py
Schema Builder: Follow the prompts to define your schema.
Include 'Auth-Token'? (Y/n):
Enter the display name (alias) for 'Auth-Token' (press Enter to keep as is): Authkey
'Auth-Token' can only go in 'header'. Automatically selected.
Include 'HostName'? (Y/n): n
Include 'Content-type'? (Y/n): y
Enter the display name (alias) for 'Content-type' (press Enter to keep as is):
'Content-type' can only go in 'header'. Automatically selected.
Default value for 'Content-type' is 'application/json'.
Do you want to change it? (y/N):
Include 'User-agent'? (Y/n):
Enter the display name (alias) for 'User-agent' (press Enter to keep as is):
'User-agent' can only go in 'header'. Automatically selected.
Default value for 'User-agent' is 'AUDITLOGS/1.0'.
Do you want to change it? (y/N):
Include 'Role'? (Y/n): y
Enter the display name (alias) for 'Role' (press Enter to keep as is):
Where should 'Role' be included? (HEADER/payload): HEADER
Default value for 'Role' is 'GW'.
Do you want to change it? (y/N): y
Enter new default value for 'Role': Gateway
<!--NeedCopy-->

Exemple de fichier de schéma généré

{
     "Header": {
         "Auth-Token": {
             "name": "AuthKey"
         },
         "Content-type": {
             "name": "Content-type",
             "value": "application/json"
         },
         "User-agent": {
             "name": "User-agent",
             "value": "AUDITLOGS/1.0"
         },
         "Role": {
             "name": "Role",
             "value": "Gateway"
         },
         "MachineIP": {
             "name": "MachineIP"
         },
         "MachineName": {
             "name": "MachineName"
         }
     },
     "Payload": {
         "LogLevel": "Level",
         "MessageContent": "Message",
         "ModuleName": "Module",
         "Time": "TimeStamp"
     },
     "Format": {
         "delimiter": ""
     }
 }
<!--NeedCopy-->
  • Quittez le shell et revenez à l’interface de ligne de commande (CLI) de NetScaler
  • Créez une action syslog qui définit le serveur Syslog, les ports et le fichier de schéma (créé à l’étape précédente) etc.
add audit syslogAction {Action Name} {AOT Server IP/FQDN} -serverPort {Destination Port} -logLevel {Log Level} -transport HTTP -httpAuthToken {Authentication Token generated on the AOT sever} -httpEndpointUrl {AOT Server URL where logs will be sent} -httpSchemaFile {Schema File created in Previous Step}
<!--NeedCopy-->

Exemple :

add audit syslogAction act1 10.102.154.196 -serverPort 8088 -logLevel ALL -transport HTTP -httpAuthToken fbb94d5b234d86a6cb155e3f808dd33c9698a0d1a866e814573b1909e4c9e56896f433da1071e3276bd133269fd69203d8f29166816f4d427e709773ceb9d41d531043331f7f76 -httpEndpointUrl "/services/collector/event" -httpSchemaFile sample.json
<!--NeedCopy-->
  • Associez l’action syslog à la stratégie Syslog d’audit
add audit syslogPolicy {PolicyName} True {Name of the Syslog Action}
<!--NeedCopy-->

Exemple :

add audit syslogPolicy pol1 true act1
<!--NeedCopy-->
Chargement des journaux AOT depuis les composants principaux CVAD