Product Documentation

Citrix Insight Services

Jun 20, 2017

Citrix Insight Services (CIS) est la plate-forme Citrix depuis laquelle vous pouvez générer des informations d'instrumentation, de télémétrie et autres données de l'entreprise. Ses fonctionnalités d'instrumentation et de télémétrie permettent aux utilisateurs techniques (clients, partenaires et techniciens) de diagnostiquer et de résoudre les problèmes ainsi que d'optimiser leurs environnements. Pour plus d'informations sur CIS et son fonctionnement, veuillez consulter le site https://cis.citrix.com/(informations d'identification de compte Citrix requises). 

Toutes les informations chargées sur Citrix Insight Services sont utilisées à des fins de dépannage et de diagnostic, ainsi que pour améliorer la qualité, la fiabilité et les performances des produits, sous réserve de ce qui suit :

Cette version de XenApp et XenDesktop prend en charge les technologies et outils suivants.

  • Analyse de l'installation et de la mise à niveau de XenApp et XenDesktop
  • Programme d'amélioration de l'expérience du client Citrix
  • Citrix Call Home
  • Citrix Scout

Installer et mettre à niveau les outils d’analyse

Lorsque vous utilisez le programme d'installation du produit complet pour déployer et mettre à niveau les composants XenApp ou XenDesktop, des informations anonymes sur le processus d'installation sont collectées et stockées sur la machine sur laquelle vous installez/mettez à niveau le composant. Ces données sont utilisées pour aider Citrix à améliorer l'expérience de ses clients avec l'installation. Pour de plus amples informations, consultez http://more.citrix.com/XD-INSTALLER.

Les informations sont stockées localement sous %ProgramData%\Citrix\CTQs.

Le chargement automatique de ces données est activé par défaut dans les interfaces graphique et de ligne de commande du programme d'installation du produit entier. 

  • Vous pouvez changer la valeur par défaut dans un paramètre de registre. Si vous modifiez le paramètre de registre avant l'installation ou la mise à niveau, cette valeur est utilisée lorsque vous utilisez le programme d'installation du produit entier.
  • Vous pouvez remplacer le paramètre par défaut si vous installez ou mettez à niveau à l'aide de l'interface de ligne de commande en spécifiant une option avec la commande.

Paramètre de registre qui contrôle le chargement automatique des outils d'analyse d'installation et de mise à niveau (valeur par défaut=1) :

Emplacement : HKLM:\Software\Citrix\MetaInstall
Nom : SendExperienceMetrics
Valeur : 0 = désactivé, 1 = activé

L'applet de commande PowerShell suivante désactive le chargement automatique des outils d'analyse d'installation et de mise à niveau :

New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\MetaInstall -Name SendExperienceMetrics -PropertyType DWORD -Value 0

Pour désactiver les chargements automatiques à l'aide de la commande XenDesktopServerSetup.exe ou XenDesktopVDASetup.exe, spécifiez l'option /disableexperiencemetrics.

Pour activer les chargements automatiques à l'aide de la commande XenDesktopServerSetup.exe ou XenDesktopVDASetup.exe, spécifiez l'option /sendexperiencemetrics.

Programme d'amélioration de l'expérience du client Citrix (CEIP)

Lorsque vous choisissez de participer au Programme d'amélioration de l'expérience utilisateur (CEIP), des informations d'utilisation et des statistiques anonymes sont envoyées à Citrix pour nous aider à améliorer la qualité et les performances des produits Citrix. Pour de plus amples informations, consultez la section http://more.citrix.com/XD-CEIP

Inscription lors de la création ou de la mise à niveau d'un site

Vous êtes automatiquement inscrit au programme CEIP lorsque vous créez un site XenApp ou XenDesktop (lorsque vous installez le premier Delivery Controller). Le premier chargement de données se produit approximativement sept jours après la création du site. Vous pouvez arrêter votre participation à tout moment après la création du site ; sélectionnez le nœud Configuration dans le panneau de navigation de Studio (onglet Assistance produit) et suivez les instructions.

Lorsque vous mettez à niveau un déploiement de XenApp ou XenDesktop :

  • Si vous mettez à niveau à partir d’une version qui ne prend pas en charge le programme CEIP, le système vous demandera si vous souhaitez y prendre part.
  • Si vous mettez à niveau à partir d’une version qui prend en charge le programme CEIP et que la participation a été activée, CEIP sera activé dans le site mis à niveau.
  • Si vous mettez à niveau à partir d’une version qui prend en charge le programme CEIP et que la participation a été désactivée, CEIP sera désactivé dans le site mis à niveau.
  • Si vous mettez à niveau à partir d’une version qui prend en charge le programme CEIP et que la participation est inconnue, le système vous demandera si vous souhaitez y prendre part. 

Les informations collectées sont anonymes, de façon à ce qu'elles ne puissent pas être consultées après leur chargement auprès de Citrix Insight Services.

Inscription lors de l'installation d'un VDA

Par défaut, vous êtes automatiquement inscrit au programme CEIP lorsque vous installez un VDA Windows. Vous pouvez modifier cette valeur par défaut dans un paramètre de registre. Si vous modifiez le paramètre de registre avant d'installer le VDA, cette valeur est utilisée.

Paramètre de registre qui contrôle le chargement automatique des outils d'analyse d'installation et de mise à niveau (valeur par défaut=1) :

Emplacement : HKLM:\Software\Citrix\Telemetry\CEIP
Nom : Enabled
Valeur : 0 = désactivé, 1 = activé

Par défaut, la propriété « Enabled » est masquée dans le registre. Si elle n'est pas spécifiée, la fonctionnalité de chargement automatique est activée.

L'applet de commande PowerShell suivante désactive l'inscription au programme CEIP :

New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\Telemetry\CEIP -Name Enabled -PropertyType DWORD -Value 0

Le premier chargement de données se produit approximativement sept jours après l'installation du VDA.

Inscription lors de l'installation d'autres produits et composants

Vous pouvez également participer au programme CEIP lorsque vous installez des produits, composants et technologies Citrix, tels que Provisioning Services, AppDNA, le serveur de licences Citrix, Citrix Receiver pour Windows, le serveur d'impression universelle et l'enregistrement de session. Consultez la documentation respective de chaque composant pour de plus amples informations sur l'installation et les valeurs de participation par défaut.

Citrix Call Home

Lors de l'installation de certains composants et fonctionnalités de XenApp ou XenDesktop, vous aurez la possibilité de participer à Citrix Call Home. Call Home collecte des données de diagnostic, puis charge périodiquement des paquets de télémétrie contenant ces données directement à Citrix Insight Services (via HTTPS sur le port 443 par défaut) à des fins d'analyse et de résolution des problèmes.

Call Home s'exécute en tant que service d'arrière-plan sous le nom Service de télémétrie Citrix.

Pour de plus amples informations, consultez http://more.citrix.com/XD-CALLHOME.

Quelles informations sont collectées ?

Le traçage Citrix Diagnostic Facility (CDF) consigne les informations qui peuvent être utiles pour la résolution des problèmes. Call Home collecte un sous-ensemble des traces CDF qui peut être utile lors de la résolution des problèmes courants, par exemple, les enregistrements de VDA et le lancement d'application/bureau. Cette technologie est appelée traçage permanent (AOT). Call Home ne recueille pas d’autres informations de Suivi d’événements pour Windows (ETW), et ne peut pas être configuré pour le faire.

Call Home recueille également d'autres informations, telles que :

  • Clés de registre créées par XenApp et XenDesktop sous HKEY_LOCAL_MACHINE\SOFTWARE\Citrix
  • Informations Infrastructure de gestion Windows (WMI) sous l'espace de noms de Citrix
  • Liste des processus en cours d'exécution
  • Vidages sur incident des processus Citrix qui sont stockés dans %PROGRAM DATA%\Citrix\CDF

Les informations de trace sont compressées lorsqu'elles sont collectées. Le Citrix Telemetry Service conserve un maximum de 10 Mo d’informations de traçage récentes comprimées, pendant une période maximale de huit jours. 

  • La compression des données permet à Call Home de limiter l’encombrement sur le VDA.
  • Les traces sont stockées dans la mémoire pour éviter des opérations d'entrées/sortie sur les machines provisionnées.
  • Le tampon de suivi utilise un mécanisme circulaire pour conserver les traces en mémoire.
htm

Points de données clés Call Home

Call Home collects these key datapoints.

Configurer et gérer : résumé

Vous pouvez indiquer si vous souhaitez ou non participer à Call Home lorsque vous installez un Delivery Controller ou un VDA à l'aide de l'interface graphique du programme d'installation du produit complet. 

Après l'installation des composants, vous pouvez utiliser les applets de commande PowerShell pour :

  • Activer les chargements planifiés de Call Home ou modifier votre calendrier actuel. Ceci comprend l'activation des chargements planifiés dans une image principale utilisée dans un catalogue de machines, ce qui évite d'avoir à configurer Call Home dans chaque VM créée.
  • Collecter manuellement les données et les charger sur CIS.
  • Collecter manuellement les données et les stocker localement, puis les charger ultérieurement sur CIS.

Pour obtenir une syntaxe complète des applets de commande PowerShell, consultez l'aide des applets de commande.

Si vous avez opté pour le chargement de données Call Home à intervalles réguliers et que vous chargez manuellement des informations de diagnostic sur CIS, vous devez fournir les informations d'identification d’accès au compte Citrix.CIS échange les informations d'identification contre un jeton de chargement qui est utilisé pour identifier le client et charger les données. Les informations d'identification ne sont pas enregistrées.

Lorsqu'un chargement se produit, une notification est envoyée par e-mail à l'adresse associée au compte Citrix. 

Activer et configurer des chargements programmés

Vous pouvez choisir de charger des données sur Call Home à intervalles réguliers lors de l'utilisation de l'assistant d'installation du produit complet ou plus tard, à l'aide d’applets de commande PowerShell. Par défaut, les données sont collectées et chargées sur CIS chaque dimanche à environ 3h00 du matin, heure locale. L'heure de chargement est aléatoire avec un intervalle de deux heures depuis l'heure spécifiée. Cela signifie qu'un chargement avec la programmation par défaut se produit entre 3h00 et 5h00.

Si vous ne souhaitez pas charger d’informations de diagnostic à intervalles réguliers, vous pouvez toujours utiliser les applets de commande PowerShell pour collecter et charger manuellement les données Call Home.

Activer des chargements programmés lors de l'installation de composants

Lorsque vous utilisez l'interface graphique du programme d'installation complet de XenApp et de XenDesktop pour installer un Controller ou un VDA, vous pouvez indiquer si vous souhaitez participer ou non au chargement programmé d’informations sur Call Home. Par défaut, la participation est sélectionnée. 

  • Si vous voulez participer, connectez-vous à CIS l'aide des informations d'identification de votre compte Citrix.
  • Si vous ne souhaitez pas participer (ou si vous souhaitez participer, mais que les informations d'identification de votre compte Citrix n'ont pas pu être validées), refusez de participer sur la page de l'assistant. Vous pouvez vous inscrire ultérieurement après l’installation du site, à l'aide des applets de commande PowerShell.

Lorsque vous installez un Controller, vous ne pouvez pas configurer d'informations sur la page Call Home de l'assistant d'installation si le serveur possède un objet de stratégie de groupe Active Directory dans lequel le paramètre de stratégie « Ouvrir une session en tant que service » est activé. Pour plus d’informations, veuillez consulter l'article CTX218094.

Activer des chargements programmés à l'aide d’applets de commande PowerShell

Entrez les applets de commande suivantes pour activer le chargement programmé d’informations de diagnostic Call Home sur CIS. Si vous n'entrez pas d'applets de commande supplémentaires pour un programme personnalisé, le programme par défaut est utilisé.

$cred = Get-Credential
Enable-CitrixCallHome -Credential $cred

Pour confirmer que les chargements programmés sont activés, entrez Get-CitrixCallHome. Cette commande devrait renvoyer IsEnabled=True et IsMasterImage=False.

Activer des chargements programmés pour des machines créées à partir d'une image principale

L'activation de chargements programmés dans une image principale vous évite d'avoir à configurer chaque machine qui est créée dans le catalogue de machines.

Enable-CitrixCallHome -Credential $cred -MasterImage

Pour confirmer que les chargements programmés sont activés, entrez Get-CitrixCallHome. Cette commande devrait renvoyer IsEnabled=True et IsMasterImage=True.

Créer un calendrier personnalisé

Vous pouvez créer un calendrier quotidien ou hebdomadaire personnalisé.

$timespan = New-TimeSpan –Hours -Minutes
Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek -UploadFrequency {Daily|Weekly}

Annuler des chargements programmés

Entrez l'applet de commande suivante pour annuler des chargements programmés. (Vous pouvez toujours charger des données de diagnostic à l'aide d’applets de commande PowerShell.)

Disable-CitrixCallHome

Pour confirmer que les chargements programmés sont désactivés, entrez Get-CitrixCallHome. Cette commande devrait renvoyer IsEnabled=False et IsMasterImage=False.

Exemples

Les applets de commande suivantes créent un programme qui collecte et charge les données à 23:20 chaque soir. Notez que le paramètre Heures utilise une horloge de 24 heures. Lorsque la valeur du paramètre UploadFrequency est Daily, le paramètre DayOfWeek est ignoré, s’il est spécifié. 

$timespan – New-TimeSpan –Hours 22 –Minutes 20
Set-CitrixCallHomeSchedule –TimeOfDay $timespan -UploadFrequency Daily

Pour confirmer le programme, entrez Get-CitrixCallHomeSchedule. Dans l'exemple ci-dessus, cette commande devrait renvoyer StartTime=22:20:00, DayOfWeek=Sunday (ignored), Upload Frequency=Daily.

Les applets de commande suivantes créent un programme qui collecte et charge les données à 23:20 chaque mercredi soir.  

$timespan – New-TimeSpan –Hours 22 –Minutes 20
Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek Wed -UploadFrequency Weekly

Pour confirmer le programme, entrez Get-CitrixCallHomeSchedule. Dans l'exemple ci-dessus, cette commande devrait renvoyer StartTime=22:20:00, DayOfWeek=Wednesday, Upload Frequency=Weekly. 

Configurer un serveur proxy pour les chargements effectués par Call Home

Les diagrammes de la procédure suivante contiennent l'adresse et le port du serveur 10.158.139.37:3128. Vos informations seront différentes.

Étape 1. Ajoutez les informations du serveur proxy dans votre navigateur. Dans Internet Explorer, sélectionnez Options Internet > Connexions > Paramètres LAN. Sélectionnez Utiliser un serveur proxy pour le réseau local, puis entrez le numéro d’adresse et le port du serveur proxy.

Étape 2. Dans PowerShell, exécutez netsh winhttp import proxy source=ie.

localized image

Étape 3. À l’aide d’un éditeur de texte, modifiez le fichier de configuration TelemetryService.exe, qui se trouve dans C:\Program Files\Citrix\Telemetry Service. Ajoutez les informations affichées dans la zone rouge ci-dessous. 

localized image

Étape 4. Redémarrez le service de télémétrie.

Exécutez les applets de commande Call Home dans PowerShell.

Collecter et charger manuellement des informations de diagnostic

Vous pouvez utiliser le site Web CIS pour charger des packages d’informations de diagnostic sur CIS. Vous pouvez également utiliser les applets de commande PowerShell pour collecter et charger des informations de diagnostic sur CIS.

Pour charger un package à l'aide du site Web CIS :

  1. Connectez-vous à Citrix Insight Services à l'aide des informations d'identification de votre compte Citrix.
  2. Sélectionnez My Workspace.
  3. Sélectionnez Healthcheck, puis accédez à l'emplacement de vos données.

CIS prend en charge plusieurs applets de commande PowerShell qui gèrent le chargement de données. Cette documentation couvre les applets de commande pour deux cas courants :

  • Utilisez l'applet de commande Start-CitrixCallHomeUpload pour collecter et charger manuellement un package d’informations de diagnostic sur CIS. (Le package n'est pas enregistré localement).
  • Utilisez l'applet de commande Start-CitrixCallHomeUpload pour collecter manuellement des données et stocker un package d’informations de diagnostic localement. Cela vous permet d'afficher un aperçu des données. Ensuite, à une date ultérieure, utilisez l'applet de commande Send-CitrixCallHomeBundle pour charger manuellement une copie de ce package sur CIS. (Les données que vous avez enregistrées à l’origine restent locales).

L'aide de PowerShell fournit une syntaxe complète, y compris des descriptions des applets de commande et des paramètres qui ne sont pas utilisés dans ces cas d'utilisation courants. 

Lorsque vous entrez une applet de commande pour charger des données sur CIS, vous êtes invité à confirmer le chargement. Si l'applet de commande expire avant que le chargement ne soit terminé, vérifiez l’état du chargement dans le journal d'événements système. La demande de chargement peut être rejetée si le service est déjà en train d’effectuer un chargement.

Collecter des données et charger le package sur CIS

Start-CitrixCallHomeUpload [-Credential] [-InputPath ] [-Description ] [-IncidentTime ] [-SRNumber ] [-Name ] [-UploadHeader ] [-AppendHeaders ] [-Collect ] []

Collecter des données et les enregistrer localement

Start-CitrixCallHomeUpload -OutputPath [-InputPath ] [-Description ] [-IncidentTime ] [-SRNumber ] [-Name ] [-UploaderHeader ] [-AppendHeaders ] [-Collect ] []

Paramètre

Description

Certificats

Dirige le chargement sur CIS.

InputPath

Emplacement du fichier zip à inclure dans le package. Il peut s’agir d’un fichier supplémentaire qui vous a été demandé par l'assistance de Citrix. Veillez à inclure l'extension .zip.

OutputPath

Emplacement où les informations de diagnostic seront enregistrées. Ce paramètre est requis lors de l'enregistrement des données Call Home localement.

Description et Incident Time

Informations sur le chargement en format libre.

SRNumber

Numéro d’incident de l’assistance technique de Citrix.

Nom

Nom qui identifie le package.

UploadHeader

Chaîne au format JSON qui spécifie les en-têtes de chargement chargés sur CIS.

AppendHeaders

Chaîne au format JSON qui spécifie les en-têtes ajoutés chargés sur CIS.

Collect

Chaîne au format JSON qui spécifie les données à collecter ou ignorer, au format {'collector':{'enabled':Boolean}}", où Boolean est true ou false.

Valeurs de collecteur valides :

  •  'wmi'
  • 'process'
  •  'registry
  • ''crashreport'
  • 'trace'
  • 'localdata'
  • 'sitedata'
  • 'sfb'

Par défaut, tous les collecteurs mis à part « sfb » sont activés. 

Le collecteur « sfb » est conçu pour être utilisé sur demande pour diagnostiquer les problèmes de Skype Entreprise. Outre le paramètre « enabled », le collecteur « sfb » prend en charge les paramètres « account » et « accounts » pour spécifier des utilisateurs cibles. Utilisez une des formules suivantes :

"-Collect "{'sfb':{'account':'domain\\user1'}}"

-Collect "{'sfb':{'accounts':['domain\\user1', 'domain\\user2']}}"

Paramètres courants

Consultez l'aide de PowerShell.

Charger des données qui étaient préalablement enregistrées localement

Send-CitrixCallHomeBundle -Credential -Path []

Le paramètre Path spécifie l'emplacement dans lequel le package était préalablement enregistré.

Exemples

L'applet de commande suivante demande le chargement des données Call Home (à l'exception des données du collecteur WMI) sur CIS. Ces données sont liées aux échecs d’enregistrement des VDA PVS, ce qui est indiqué à 14:30 pour le ticket de support technique de Citrix 123456. En plus des données Call Home, le fichier « c:\Diagnostics\ExtraData.zip » sera incorporé au package chargé.

C:\PS>Start-CitrixCallHomeUpload -InputPath "c:\Diagnostics\ExtraData.zip" -Description "Registration failures with PVS VDAs" -IncidentTime "14:30" -SRNumber 123456 -Name "RegistrationFailure-021812016" -Collect "{'wmi':{'enabled':false}}" -UploadHeader "{'key1':'value1'}" -AppendHeaders "{'key2':'value2'}"

L'applet de commande suivante enregistre les données Call Home liées au ticket de support technique de Citrix 223344, ce qui est indiqué à 8:15. Les données seront enregistrées dans le fichier mydata.zip sur un partage réseau. En plus des données Call Home, le fichier « c:\Diagnostics\ExtraData.zip » sera incorporé au package enregistré.

C:\PS>Start-CitrixCallHomeUpload -OutputPath \\mynetwork\myshare\mydata.zip -InputPath "c:\Diagnostics\ExtraData.zip" -Description "Diagnostics for incident number 223344" -IncidentTime "8:15" -SRNumber 223344

L'applet de commande suivante charge le package de données que vous avez enregistré précédemment.

$cred=Get-Credential
C:\PS>Send-CitrixCallHomeBundle –Credential $cred -Path \\mynetwork\myshare\mydata.zip

Citrix Scout

Citrix Scout est le prédécesseur de Call Home. Il capture et charge les points de données clés et les traces CDF. Voir CTX130147 pour de plus amples informations sur Citrix Scout.

Vous pouvez télécharger le logiciel Citrix Scout depuis cet article. Le logiciel est également disponible sur l'ISO XenApp et XenDesktop.