シトリックス インサイト サービス
Citrix Insight Services (CIS) は、計測、テレメトリ、およびビジネスインサイトの生成のためのCitrixプラットフォームです。その計測およびテレメトリ機能により、技術ユーザー(顧客、パートナー、エンジニア)は、問題を自己診断して修正し、環境を最適化できます。CIS の詳細および最新情報、およびその仕組みについては、https://cis.citrix.com を参照してください(Citrix アカウントの資格情報が必要です)。
Citrix Insight Services が提供する機能は成長と進化を続けており、現在では Citrix Smart Tools の不可欠な一部となっています。Citrix Smart Tools を使用すると、展開タスク、ヘルスチェック、および電源管理を自動化できます。これらのテクノロジーに関する情報については、Citrix Smart Tools のドキュメントを参照してください。
Citrix にアップロードされるすべての情報は、製品の品質、信頼性、およびパフォーマンスの向上だけでなく、トラブルシューティングと診断の目的で使用されます。ただし、以下の条件に従います。
- https://cis.citrix.com/legal にある シトリックス インサイト サービス ポリシー
- https://www.citrix.com/about/legal/privacy.html にある Citrix プライバシーポリシー
この XenApp and XenDesktop® リリースは、以下のツールとテクノロジーをサポートしています。
- XenApp® および XenDesktop のインストールとアップグレードの分析
- Citrix カスタマーエクスペリエンス向上プログラム
- シトリックス スマートツール
- シトリックス コールホーム (シトリックス スマートツール の一部)
- シトリックス スカウト
インストールとアップグレードの分析
フルプロダクトインストーラーを使用して XenApp または XenDesktop コンポーネントを展開またはアップグレードすると、インストールプロセスに関する匿名情報が、コンポーネントをインストール/アップグレードしているマシンに収集され、保存されます。このデータは、Citrix が顧客のインストールエクスペリエンスを向上させるのに役立てられます。
この情報は、%ProgramData%\Citrix\CTQs にローカルに保存されます。
このデータの自動アップロードは、フルプロダクトインストーラーのグラフィカルインターフェイスとコマンドラインインターフェイスの両方でデフォルトで有効になっています。
- レジストリ設定でデフォルト値を変更できます。インストール/アップグレード前にレジストリ設定を変更すると、フルプロダクトインストーラーを使用する際にその値が使用されます。
- コマンドラインインターフェイスでインストール/アップグレードする場合、コマンドでオプションを指定することでデフォルト設定を上書きできます。
インストール/アップグレード分析の自動アップロードを制御するレジストリ設定(デフォルト = 1):
Location: HKLM:\Software\Citrix\MetaInstall Name: SendExperienceMetrics Value: 0 = disabled, 1 = enabled
PowerShellを使用すると、次のコマンドレットでインストール/アップグレード分析の自動アップロードを無効にできます。
New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\MetaInstall -Name SendExperienceMetrics -PropertyType DWORD -Value 0
XenDesktopServerSetup.exe または XenDesktopVDASetup.exe コマンドを使用して自動アップロード機能を無効にする場合は、/disableexperiencemetrics オプションを指定する必要があります。
XenDesktopServerSetup.exe または XenDesktopVDASetup.exe コマンドを使用して自動アップロード機能を有効にする場合は、/sendexperiencemetrics オプションを指定する必要があります。
Citrixカスタマーエクスペリエンス向上プログラム(CEIP)
Citrixカスタマーエクスペリエンス向上プログラム(CEIP)に参加すると、Citrix製品の品質とパフォーマンスの向上に役立てるため、匿名の統計情報と使用状況情報がCitrixに送信されます。詳細については、https://more.citrix.com/XD-CEIPを参照してください。
サイト作成時またはアップグレード時の登録
XenAppまたはXenDesktopサイトを作成すると(最初のDelivery Controller™をインストールした後)、CEIPに自動的に登録されます。データの最初のアップロードは、サイト作成後約7日で行われます。サイト作成後であればいつでも参加を停止できます。Studioナビゲーションペイン(製品サポートタブ)で構成ノードを選択し、ガイダンスに従ってください。
XenAppまたはXenDesktop展開をアップグレードする場合:
- CEIPをサポートしていないバージョンからアップグレードする場合、参加するかどうかを尋ねられます。
- CEIPをサポートしていたバージョンからアップグレードし、参加が有効になっていた場合、アップグレードされたサイトでCEIPが有効になります。
- CEIPをサポートしていたバージョンからアップグレードし、参加が無効になっていた場合、アップグレードされたサイトでCEIPが無効になります。
- CEIPをサポートしていたバージョンからアップグレードし、参加状況が不明な場合、参加を希望するかどうか尋ねられます。
収集された情報は匿名であるため、Citrix Insight Servicesにアップロードされた後は表示できません。
VDAのインストール時の登録
デフォルトでは、Windows VDAをインストールすると、CEIPに自動的に登録されます。このデフォルト設定はレジストリ設定で変更できます。VDAをインストールする前にレジストリ設定を変更すると、その値が使用されます。
CEIPへの自動登録を制御するレジストリ設定(デフォルト = 1):
Location: HKLM:\Software\Citrix\Telemetry\CEIP Name: Enabled Value: 0 = disabled, 1 = enabled
デフォルトでは、「Enabled」プロパティはレジストリに隠されています。指定されていない場合、自動アップロード機能は有効になります。
PowerShellを使用すると、次のコマンドレットでCEIPへの登録を無効にできます。
New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\Telemetry\CEIP -Name Enabled -PropertyType DWORD -Value 0
収集されたランタイムデータポイントは、定期的にファイルとして出力フォルダー(デフォルト %programdata%/Citrix/VdaCeip)に書き込まれます。
データの初回アップロードは、VDAのインストール後約7日で行われます。
その他の製品およびコンポーネントのインストール時の登録
Provisioning Services、AppDNA、Citrix License Server、Citrix Receiver™ for Windows、Universal Print Server、Session Recordingなどの関連するCitrix製品、コンポーネント、テクノロジーをインストールする際にも、CEIPに参加できます。インストールと参加のデフォルト値の詳細については、それぞれのドキュメントを参照してください。
Citrix スマートツール
Delivery Controllerをインストールする際に、Smart Toolsへのアクセスを有効にできます。
Smart Toolsへのアクセスを有効にするオプション(および、まだ有効になっていない場合はCall Homeに参加するオプション)は、デフォルトで選択されています。Connectをクリックします。ブラウザウィンドウが開き、Smart ServicesのWebページに自動的に移動し、そこでCitrix Cloud™アカウントの資格情報を入力します。(Citrix Cloudアカウントをお持ちでない場合は、Citrixアカウントの資格情報を入力するだけで、新しいCitrix Cloudアカウントが自動的に作成されます。)認証後、証明書はSmart Tools Agentディレクトリにサイレントインストールされます。
Smart Toolsテクノロジーを使用するには、Smart Toolsのドキュメントを参照してください。
Citrix コールホーム
XenAppまたはXenDesktopで特定のコンポーネントと機能をインストールすると、Citrix Call Homeに参加する機会が提供されます。Call Homeは診断データを収集し、そのデータを含むテレメトリパッケージを、分析とトラブルシューティングのためにCitrix Insight Servicesに直接(デフォルトポート443のHTTPS経由で)定期的にアップロードします。
XenAppおよびXenDesktopでは、コールホームはCitrix Telemetry Serviceという名前のバックグラウンドサービスとして実行されます。詳細については、https://more.citrix.com/XD-CALLHOMEを参照してください。
Call Homeのスケジューリング機能はCitrix Scoutでも利用できます。詳細については、Citrix Scoutを参照してください。
収集される情報
Citrix Diagnostic Facility (CDF)トレースは、トラブルシューティングに役立つ情報をログに記録します。Call Homeは、VDA登録やアプリケーション/デスクトップの起動など、一般的な障害のトラブルシューティングに役立つCDFトレースのサブセットを収集します。このテクノロジーは、常時オンのトレース(AOT)として知られています。Call Homeは、その他のEvent Tracing for Windows (ETW)情報を収集せず、またそのように構成することもできません。
Call Homeは、次のようなその他の情報も収集します。
- Registries created by XenApp and XenDesktop under HKEY_LOCAL_MACHINE\SOFTWARE\Citrix
- Citrix 名前空間下の ウィンドウズ管理インストゥルメンテーション (WMI) 情報
- 実行中のプロセスリスト
- %PROGRAM DATA%\Citrix\CDFに保存されているCitrixプロセスのクラッシュダンプ
トレース情報は収集時に圧縮されます。Citrix Telemetry Service は、最大 10 MB の圧縮された最新のトレース情報を、最長 8 日間保持します。
- データを圧縮することで、Call Home は VDA 上で小さなフットプリントを維持できます。
- プロビジョニングされたマシンでの IOP を回避するため、トレースはメモリに保持されます。
- トレースバッファは、メモリ内のトレースを保持するために循環メカニズムを使用します。
Call Home は、以下の主要なデータポイントを収集します: Call Home の主要なデータポイント
構成と管理の概要
Call Home には、製品版インストールウィザードの使用時、または後で PowerShell コマンドレットを使用して登録できます。登録すると、デフォルトで診断情報が毎週日曜日の現地時間午前 3 時頃に収集され、Citrix にアップロードされます。アップロードは、指定された時刻から 2 時間の範囲でランダム化されます。これは、デフォルトのスケジュールを使用するアップロードが午前 3 時から午前 5 時の間に発生することを意味します。
診断情報をスケジュールに基づいてアップロードしたくない場合 (またはスケジュールを変更したい場合) は、PowerShell コマンドレットを使用して診断情報を手動で収集してアップロードするか、ローカルに保存することができます。
スケジュールされた Call Home アップロードに登録する場合、および診断情報を手動で Citrix にアップロードする場合、Citrix アカウントまたは Citrix Cloud の資格情報を提供します。Citrix は、その資格情報を、顧客を識別しデータをアップロードするために使用されるアップロードトークンと交換します。資格情報は保存されません。
アップロードが発生すると、Citrix アカウントに関連付けられたアドレスに通知メールが送信されます。
前提条件
- マシンには PowerShell 3.0 以降が実行されている必要があります。
- Citrix Telemetry Service がマシン上で実行されている必要があります。
- システム変数 PSModulePath は、Telemetry のインストールパスに設定されている必要があります。例えば、そのパスは C:\Program Files\Citrix\Telemetry Service\ のようになります。
コンポーネントのインストール中に Call Home を有効にする
VDAのインストールまたはアップグレード中: フルプロダクトインストーラーのグラフィカルインターフェイスを使用してVirtual Delivery Agentをインストールまたはアップグレードする際、Call Homeに参加するかどうかを尋ねられます。2つのオプションがあります。
- 「コールホーム」に参加する。
- Call Homeに参加しない。
VDAをアップグレードしていて、以前にCall Homeに登録していた場合、そのウィザードページは表示されません。
Controllerのインストールまたはアップグレード中: グラフィカルインターフェイスを使用してDelivery Controllerをインストールまたはアップグレードする際、Call Homeに参加し、Citrix Smart Toolsに接続するかどうかを尋ねられます。3つのオプションがあります。
- Smart Toolsエージェントを介してCall Home機能を含むCitrix Smart Toolsに接続します。これはデフォルトで推奨されるオプションです。このオプションを選択すると、Smart Toolsエージェントが構成されます。(このオプションが選択されているかどうかにかかわらず、Smart Toolsエージェントはインストールされます。)
- Call Homeにのみ参加し、Smart Toolsには接続しません。このオプションを選択すると、Smart Toolsエージェントはインストールされますが、構成されません。Call Home機能は、Citrix Telemetry ServiceおよびCitrix Insight Servicesを通じて提供されます。
- Smart Toolsに接続せず、Call Homeにも参加しません。
Controllerをインストールする際、そのサーバーに「サービスとしてログオン」ポリシー設定が適用されたActive Directory GPOがある場合、インストールウィザードのCall Homeページで情報を構成することはできません。詳細については、CTX218094を参照してください。
Controllerをアップグレードしていて、以前にCall Homeに登録していた場合、ページにはSmart Toolsについてのみ尋ねられます。すでにCall Homeに登録されており、Smart Agentがすでにインストールされている場合、ウィザードページは表示されません。
スマートツールの詳細については、スマートツールのドキュメントを参照してください。
PowerShellコマンドレット
PowerShellヘルプには、これらの一般的な使用例では使用されないコマンドレットとパラメーターの説明を含む、包括的な構文が提供されています。
アップロードにプロキシサーバーを使用するには、Configure a proxy serverを参照してください。
スケジュールされたアップロードを有効にする
診断コレクションはCitrixに自動的にアップロードされます。カスタムスケジュールに追加のコマンドレットを入力しない場合、デフォルトのスケジュールが使用されます。
$cred = Get-Credential Enable-CitrixCallHome -Credential $cred
スケジュールされたアップロードが有効になっていることを確認するには、Get-CitrixCallHomeと入力します。IsEnabled=TrueおよびIsMasterImage=Falseが返されるはずです。
マスターイメージから作成されたマシンに対してスケジュールされたアップロードを有効にする
マスターイメージでスケジュールされたアップロードを有効にすると、マシンカタログで作成される各マシンを構成する必要がなくなります。
Enable-CitrixCallHome -Credential $cred -MasterImage
スケジュールされたアップロードが有効になっていることを確認するには、Get-CitrixCallHomeと入力します。IsEnabled=TrueおよびIsMasterImage=Trueが返されるはずです。
カスタムスケジュールを作成する
診断コレクションとアップロードの毎日または毎週のスケジュールを作成します。
$timespan = New-TimeSpan –Hours <hours> -Minutes <minutes> Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek <day> -UploadFrequency {Daily|Weekly}
スケジュールされたアップロードをキャンセルする
スケジュールされたアップロードをキャンセルした後でも、PowerShellコマンドレットを使用して診断データをアップロードできます。
Disable-CitrixCallHome
スケジュールされたアップロードが無効になっていることを確認するには、Get-CitrixCallHomeと入力します。IsEnabled=FalseおよびIsMasterImage=Falseが返されるはずです。
使用例
次のコマンドレットは、毎日夜の23時20分にデータをバンドルしてアップロードするスケジュールを作成します。Hoursパラメーターは24時間形式を使用することに注意してください。UploadFrequencyパラメーターの値がDailyの場合、DayOfWeekパラメーターは指定されていても無視されます。
$timespan – New-TimeSpan –Hours 22 –Minutes 20 Set-CitrixCallHomeSchedule –TimeOfDay $timespan -UploadFrequency Daily
To confirm the schedule, enter Get-CitrixCallHomeSchedule, In the above example,it should return StartTime=22:20:00, DayOfWeek=Sunday (ignored), Upload Frequency=Daily.
次のコマンドレットは、毎週水曜日の夜23時20分にデータをバンドルしてアップロードするスケジュールを作成します。
$timespan – New-TimeSpan –Hours 22 –Minutes 20 Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek Wed -UploadFrequency Weekly
To confirm the schedule, enter Get-CitrixCallHomeSchedule, In the above example, it should return StartTime=22:20:00, DayOfWeek=Wednesday, Upload Frequency=Weekly.
Call Homeアップロード用のプロキシサーバーを構成する
Call Homeが有効になっているマシンで、次のタスクを完了します。以下の手順の図の例には、サーバーアドレスとポート10.158.139.37:3128が含まれています。お使いの情報は異なります。
手順1. ブラウザーにプロキシサーバー情報を追加します。Internet Explorerで、[インターネットオプション] > [接続] > [LANの設定] を選択します。「LANにプロキシサーバーを使用する」を選択し、プロキシサーバーのアドレスとポート番号を入力します。
Step 2. In PowerShell, run netsh winhttp import proxy source=ie.
Call Homeプロキシの図(/ja-jp/xenapp-and-xendesktop/7-15-ltsr/media/call-home-proxy-ie.png)
手順3. テキストエディターを使用して、C:\Program Files\Citrix\Telemetry ServiceにあるTelemetryService.exe構成ファイルを編集します。以下の赤いボックスに示されている情報を追加します。
Call Homeプロキシ構成の図(/ja-jp/xenapp-and-xendesktop/7-15-ltsr/media/call-home-proxy-config.png)
手順4. テレメトリサービスを再起動します。
PowerShellでCall Homeコマンドレットを実行します。
診断情報を手動で収集してアップロードする
CIS Webサイトを使用して、診断情報バンドルをCISにアップロードできます。PowerShellコマンドレットを使用して、診断情報を収集し、CISにアップロードすることもできます。
CIS Webサイトを使用してバンドルをアップロードするには:
- Citrixアカウントの資格情報を使用してCitrix Insight Servicesにログオンします。
- 「My Workspace」オプションを選択します。
- [Healthcheck] を選択し、データの場所に移動します。
CISは、データアップロードを管理するいくつかのPowerShellコマンドレットをサポートしています。このドキュメントでは、2つの一般的なケースのコマンドレットについて説明します。
- Start-CitrixCallHomeUploadコマンドレットを使用して、診断情報バンドルを手動で収集し、CISにアップロードします。(バンドルはローカルに保存されません。)
- Start-CitrixCallHomeUploadコマンドレットを使用して、データを手動で収集し、診断情報バンドルをローカルに保存します。これにより、データをプレビューできます。その後、Send-CitrixCallHomeBundleコマンドレットを使用して、そのバンドルのコピーを手動でCISにアップロードします。(最初に保存したデータはローカルに残ります。)
PowerShellヘルプには、これらの一般的なユースケースでは使用されないコマンドレットとパラメーターの説明を含む、包括的な構文が記載されています。
データをCISにアップロードするコマンドレットを入力すると、アップロードの確認を求められます。アップロードが完了する前にコマンドレットがタイムアウトした場合は、システムイベントログでアップロードのステータスを確認してください。サービスがすでにアップロードを実行している場合、アップロード要求は拒否されることがあります。
データを収集し、バンドルをCISにアップロードする
Start-CitrixCallHomeUpload [-Credential] <PSCredential> [-InputPath <String>] [-Description <String>] [-IncidentTime <String>] [-SRNumber <String>] [-Name <String>] [-UploadHeader <String>] [-AppendHeaders <String>] [-Collect <String>] [<CommonParameters>]
データを収集してローカルに保存する
Start-CitrixCallHomeUpload -OutputPath <String> [-InputPath <String>] [-Description <String>] [-IncidentTime <String>] [-SRNumber <String>] [-Name <String>] [-UploaderHeader <String>] [-AppendHeaders <String>] [-Collect <String>] [<CommonParameters>]
| パラメーター | Description |
|---|---|
| 資格情報 | アップロードをCISに指示します。 |
| 入力パス | バンドルに含めるzipファイルの場所。これはCitrixサポートが要求する追加ファイルである可能性があります。.zip拡張子を含めるようにしてください。 |
| 出力パス | 診断情報が保存される場所。このパラメーターは、Call Homeデータをローカルに保存する場合に必要です。 |
| 説明とインシデント時間 | アップロードに関する自由形式の情報。 |
| SR番号 | Citrixテクニカルサポートのインシデント番号。 |
| 名前 | バンドルを識別する名前。 |
| アップロードヘッダー | CISにアップロードされるアップロードヘッダーを指定するJSON形式の文字列。 |
| ヘッダー付加 | CISにアップロードされる追加ヘッダーを指定するJSON形式の文字列。 |
| 収集 | 収集または除外するデータを指定するJSON形式の文字列。形式は{‘collector’:{‘enabled’:Boolean}}で、Booleanはtrueまたはfalseです。有効なコレクター値は、「wmi」、「process」、「registry」、「crashreport」、「trace」、「localdata」、「sitedata」、「sfb」です。デフォルトでは、「sfb」を除くすべてのコレクターが有効になっています。「sfb」コレクターは、Skype for Businessの問題を診断するためにオンデマンドで使用するように設計されています。「enabled」パラメーターに加えて、「sfb」コレクターはターゲットユーザーを指定するための「account」および「accounts」パラメーターをサポートしています。次のいずれかの形式を使用します: 「-Collect “{‘sfb’:{‘account’:’domain\user1’}}”」; 「-Collect “{‘sfb’:{‘accounts’:[‘domain\user1’, ‘domain\user2’]}}”」 |
| 共通パラメーター | PowerShellのヘルプを参照してください。 |
以前ローカルに保存されたデータをアップロードする
Send-CitrixCallHomeBundle -Credential <PSCredential> -Path <String> [<CommonParameters>]
Pathパラメーターは、以前に保存されたバンドルの場所を指定します。
使用例
次のコマンドレットは、Call Homeデータ(WMIコレクターからのデータを除く)をCISにアップロードするよう要求します。このデータは、Citrixサポートケース123456について午後2時30分に記録されたPVS VDAの登録失敗に関連しています。Call Homeデータに加えて、ファイル「c:\Diagnostics\ExtraData.zip」がアップロードされるバンドルに組み込まれます。
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’}”
次のコマンドレットは、午前8時15分に記録されたCitrixサポートケース223344に関連するCall Homeデータを保存します。データは、ネットワーク共有上のファイルmydata.zipに保存されます。Call Homeデータに加えて、ファイル「c:\Diagnostics\ExtraData.zip」が保存されるバンドルに組み込まれます。
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
次のコマンドレットは、以前に保存したデータバンドルをアップロードします。
$cred=Get-Credential C:\PS>Send-CitrixCallHomeBundle –Credential $cred -Path \\mynetwork\myshare\mydata.zip
シトリックス スカウト
詳細については、Citrix Scoutを参照してください。