シトリックス インサイト サービス

Citrix Insight Services (CIS) は、計測、テレメトリ、ビジネスインサイト生成のためのCitrixプラットフォームです。その計測およびテレメトリ機能により、技術ユーザー(顧客、パートナー、エンジニア)は、問題を自己診断して修正し、環境を最適化できます。CISとその仕組みに関する詳細および最新情報については、https://cis.citrix.com(Citrixアカウントの資格情報が必要です)を参照してください。

Citrixにアップロードされるすべての情報は、トラブルシューティングと診断の目的、および製品の品質、信頼性、パフォーマンスの向上に使用されます。ただし、以下の条件に従います。

このCitrix Virtual Apps and Desktops™リリースは、以下のテクノロジーをサポートしています。

CISおよびCitrix Analyticsとは別に、Studioをインストール(またはアップグレード)すると、Google Analyticsが自動的に収集(および後でアップロード)されます。Studioのインストール後、レジストリキー HKLM\Software\Citrix\DesktopStudio\GAEnabled を使用してこの設定を変更できます。値が1の場合は収集とアップロードが有効になり、0の場合は収集とアップロードが無効になります。

インストールとアップグレードの分析

フルプロダクトインストーラーを使用してCitrix Virtual Apps and Desktopsコンポーネントを展開またはアップグレードすると、インストールプロセスに関する匿名情報が、コンポーネントをインストール/アップグレードしているマシンに収集され、保存されます。このデータは、Citrixが顧客のインストールエクスペリエンスを向上させるために使用されます。

情報は、%ProgramData%\Citrix\CTQs の下にローカルに保存されます。

このデータの自動アップロードは、フルプロダクトインストーラーのグラフィカルインターフェイスとコマンドラインインターフェイスの両方で、デフォルトで有効になっています。

  • レジストリ設定のデフォルト値を変更できます。インストール/アップグレード前にレジストリ設定を変更すると、フルプロダクトインストーラーを使用する際にその値が使用されます。
  • コマンドラインインターフェイスでインストール/アップグレードする場合、コマンドでオプションを指定することで、デフォルト設定を上書きできます。

自動アップロードの制御:

  • インストール/アップグレード分析の自動アップロードを制御するレジストリ設定 (デフォルト = 1):

    • Location: HKLM:\Software\Citrix\MetaInstall
    • 名前: エクスペリエンスメトリクス送信
    • 値: 0 = 無効、1 = 有効
  • PowerShell を使用すると、次のコマンドレットでインストール/アップグレード分析の自動アップロードが無効になります:

     New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\MetaInstall -Name SendExperienceMetrics -PropertyType DWORD -Value 0
     <!--NeedCopy-->
    
  • XenDesktopServerSetup.exe または XenDesktopVDASetup.exe コマンドで自動アップロードを無効にするには、/disableexperiencemetrics オプションを含めます。

    XenDesktopServerSetup.exe または XenDesktopVDASetup.exe コマンドで自動アップロードを有効にするには、/sendexperiencemetrics オプションを含めます。

Citrixカスタマーエクスペリエンス向上プログラム

Citrixカスタマーエクスペリエンス向上プログラム (CEIP) に参加すると、匿名の統計情報と使用状況情報が Citrix に送信され、Citrix 製品の品質とパフォーマンスの向上に役立てられます。詳細については、https://more.citrix.com/XD-CEIP を参照してください。

サイト作成時またはアップグレード時の登録

サイトを作成すると (最初の Delivery Controller™ をインストールした後)、CEIP に自動的に登録されます。データの初回アップロードは、サイト作成後約7日で行われます。

サイト作成後、いつでも参加を停止できます。Web Studio の左ペインで 設定 ノードを選択し、Citrixカスタマーエクスペリエンス向上プログラム 設定をオフにします。

シトリックス バーチャルアプリ アンド デスクトップの展開をアップグレードする場合:

  • 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
<!--NeedCopy-->

収集されたランタイムデータポイントは、定期的にファイルとして出力フォルダー(デフォルト %programdata%/Citrix/VdaCeip)に書き込まれます。

データの初回アップロードは、VDAのインストール後約7日で行われます。

その他の製品およびコンポーネントのインストール時の登録

CEIPには、Citrix Provisioning™、AppDNA、Citrix License Server、Windows向けCitrix Workspace™アプリ、Universal Print Server、Session Recordingなどの関連Citrix製品、コンポーネント、テクノロジーをインストールする際にも参加できます。インストールと参加のデフォルト値の詳細については、それぞれのドキュメントを参照してください。

Citrix コールホーム

Citrix Virtual Apps and Desktopsで特定のコンポーネントと機能をインストールすると、Citrix Call Homeに参加する機会が提供されます。Call Homeは診断データを収集し、そのデータを含むテレメトリパッケージを分析とトラブルシューティングのためにCitrix Insight Servicesに直接(デフォルトポート443のHTTPS経由で)定期的にアップロードします。

Citrix Virtual Apps and Desktopsでは、Call HomeはCitrix Telemetry Serviceという名前のバックグラウンドサービスとして実行されます。詳細については、(https://www.citrix.com/community/cx/call-home.html?utm_campaign=none&utm_content=xa-xd+product+ui+learn+more&utm_source=more.citrix.com/XD-CALLHOME&utm_medium=Vanity+Url)を参照してください。

Call Homeのスケジュール機能はCitrix Scoutでも利用できます。詳細については、Citrix Scoutを参照してください。

収集されるもの

Citrix Diagnostic Facility (CDF) トレースは、トラブルシューティングに役立つ情報をログに記録します。Call Homeは、VDA登録やアプリケーション/デスクトップの起動など、一般的な障害のトラブルシューティングに役立つCDFトレースのサブセットを収集します。このテクノロジーは常時オンのトレース (AOT) として知られています。AOTログはC:\Users\CitrixTelemetryService\Appdata\Local\CitrixAOTにディスクに保存されます。

Call Homeは、その他のEvent Tracing for Windows (ETW) 情報を収集せず、またそのように構成することもできません。

Call Homeは、次のようなその他の情報も収集します。

  • HKEY_LOCAL_MACHINE\SOFTWARE\Citrix のパスに、Citrix Virtual Apps and Desktops によって作成されるレジストリ項目。
  • Citrix 名前空間下の ウィンドウズ マネジメント インストゥルメンテーション (WMI) 情報。
  • 実行中のプロセスリスト。
  • %PROGRAM DATA%\Citrix\CDFに保存されているCitrixプロセスのクラッシュダンプ。
  • インストールおよびアップグレード情報。これには、完全な製品メタインストーラーログ、失敗したMSIログ、MSIログアナライザーからの出力、StoreFront™ログ、ライセンス互換性チェックログ、および予備的なサイトアップグレードテストの結果が含まれる場合があります。

トレース情報は収集時に圧縮されます。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 アカウントに関連付けられたアドレスに通知メールが送信されます。

コンポーネントのインストール時に Call Home を有効にした場合、後で 無効にできます

前提条件

  • マシンは 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に参加するかどうかを尋ねられます。次の3つのオプションがあります。

Controllerをインストールする際、そのサーバーに「サービスとしてログオン」のポリシー設定が適用されたActive Directory GPOがある場合、インストールウィザードのCall Homeページで情報を構成することはできません。詳細については、CTX218094を参照してください。

Controllerをアップグレードしていて、以前にCall Homeに登録していた場合、参加について尋ねられることはありません。

PowerShellコマンドレット

PowerShellヘルプには、これらの一般的なユースケースでは使用されないコマンドレットとパラメーターの説明を含む、包括的な構文が記載されています。

アップロードにプロキシサーバーを使用するには、「プロキシサーバーの構成」を参照してください。

  • スケジュールされたアップロードを有効にする: 診断コレクションはCitrixに自動的にアップロードされます。カスタムスケジュール用の追加のコマンドレットを入力しない場合、デフォルトのスケジュールが使用されます。

     $cred = Get-Credential
     Enable-CitrixCallHome -Credential $cred
     <!--NeedCopy-->
    

    スケジュールされたアップロードが有効になっていることを確認するには、Get-CitrixCallHomeGet-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}
     <!--NeedCopy-->
    

例:

次のコマンドレットは、毎日夜10時20分にデータをバンドルしてアップロードするスケジュールを作成します。Hoursパラメーターは24時間形式を使用します。UploadFrequencyパラメーターの値がDailyの場合、DayOfWeekパラメーターは指定されていても無視されます。

$timespan – New-TimeSpan –Hours 22 –Minutes 20
Set-CitrixCallHomeSchedule –TimeOfDay $timespan -UploadFrequency Daily
<!--NeedCopy-->

スケジュールを確認するには、Get-CitrixCallHomeScheduleと入力します。上記の例では、StartTime=22:20:00, DayOfWeek=Sunday (ignored), Upload Frequency=Dailyが返されます。

次のコマンドレットは、毎週水曜日の夜10時20分にデータをバンドルしてアップロードするスケジュールを作成します。

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

スケジュールを確認するには、Get-CitrixCallHomeScheduleと入力します。上記の例では、StartTime=22:20:00, DayOfWeek=Wednesday, Upload Frequency=Weeklyが返されます。

Call Homeを無効にする

PowerShellコマンドレットまたはCitrix Scoutを使用してCall Homeを無効にできます。

Call Homeのスケジュールされたアップロードが無効になっている場合でも、AOTログは収集され、ディスクに保存されます(スケジュールされたアップロードが無効になっている場合、AOTログはCitrixに自動的にアップロードされません)。AOTログの収集とローカルストレージを無効にできます。

パワーシェルでコールホームを無効にする

次のコマンドレットを実行すると、診断データはCitrixに自動的にアップロードされなくなります(Citrix ScoutまたはテレメトリPowerShellコマンドレットを使用して診断データをアップロードすることは引き続き可能です)。

Disable-CitrixCallHome

Call Homeが無効になっていることを確認するには、Get-CitrixCallHomeと入力します。無効になっている場合、戻り値はIsEnabled=FalseIsMasterImage=Falseです。

Citrix Scoutを使用してコレクションスケジュールを無効にする

Citrix Scoutを使用して診断コレクションスケジュールを無効にするには、「コレクションのスケジュール」のガイダンスに従ってください。ステップ3で、Offをクリックして、選択したマシンのスケジュールをキャンセルします。

AOTログの収集を無効にする

次のコマンドレットを実行した後 (Enabled フィールドを false に設定)、AOTログは収集されません。

Enable-CitrixTrace -Listen'{"trace":{"enabled":false,"persistDirectory":"C:\Users\Public","maxSizeBytes":1000000, "sliceDurationSeconds":300}}'

Listen パラメーターには、JSON形式の引数が含まれています。

Call Homeアップロード用のプロキシサーバーを構成する

Call Homeが有効になっているマシンで、次のタスクを完了します。以下の手順の例の図には、サーバーアドレスとポート10.158.139.37:3128が含まれています。お客様の情報は異なります。

  1. ブラウザーにプロキシサーバー情報を追加します。Internet Explorerで、インターネットオプション > 接続 > LAN の設定を選択します。「LAN にプロキシ サーバーを使用する」を選択し、プロキシサーバーのアドレスとポート番号を入力します。

  2. パワーシェルで、netsh winhttp import proxy source=ie を実行します。

    プロキシサーバーを構成する際のnetshコマンド実行例

  3. テキストエディターを使用して、C:\Program Files\Citrix\Telemetry Service にある TelemetryService.exe 構成ファイルを編集します。赤枠内に示されている情報を追加します。

    TelemetryService.exeファイルにプロキシ情報を追加する

  4. テレメトリーサービスを再起動します。

PowerShellでCall Homeコマンドレットを実行します。

診断情報を手動で収集してアップロードする

CIS Webサイトを使用して、診断情報バンドルをCISにアップロードできます。PowerShellコマンドレットを使用して、診断情報を収集し、CISにアップロードすることもできます。

CIS Webサイトを使用してバンドルをアップロードするには:

  1. Citrixアカウントの資格情報を使用してCitrix Insight Servicesにログオンします。
  2. マイワークスペース」を選択します。
  3. 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>]
<!--NeedCopy-->

データを収集してローカルに保存する:

Start-CitrixCallHomeUpload -OutputPath <String> [-InputPath string] [-Description string] [-IncidentTime string] [-SRNumber string] [-Name string] [-UploaderHeader string] [-AppendHeaders string] [-Collect strings] [<CommonParameters>]
<!--NeedCopy-->

次のパラメーターが有効です。

  • Credential: アップロードをCISに指示します。
  • InputPath: バンドルに含めるzipファイルの場所。これは、Citrixサポートが要求する追加ファイルである可能性があります。.zip拡張子を含めるようにしてください。
  • OutputPath: 診断情報が保存される場所。このパラメーターは、Call Homeデータをローカルに保存する場合に必須です。
  • 説明とインシデント時刻: アップロードに関する自由形式の情報。
  • SR番号: Citrixテクニカルサポートのインシデント番号。
  • 名前: バンドルを識別する名前。
  • UploadHeader: CISにアップロードされるアップロードヘッダーを指定するJSON形式の文字列。
  • AppendHeaders: CISにアップロードされる追加ヘッダーを指定するJSON形式の文字列。
  • Collect: 収集または除外するデータを指定するJSON形式の文字列。形式は {‘collector’:{‘enabled’:Boolean}} で、Boolean は true または false です。 有効なコレクター値は次のとおりです。

    • ‘ダブリューエムアイ’
    • ‘プロセス’
    • ‘レジストリ’
    • ‘クラッシュレポート’
    • ‘トレース’
    • ‘ファイル’
    • ‘エムエスアイ’
    • ‘ローカルデータ’
    • ‘サイトデータ’
    • 「’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 <PSCredentia\> -Path string [<CommonParameters>]

Pathパラメーターは、以前に保存されたバンドルの場所を指定します。

例:

次のcmdletは、Call Homeデータ(WMIコレクターからのデータを除く)をCISにアップロードするよう要求します。このデータは、Citrix Supportケース123456について午後2時30分に記録されたCitrix Provisioning VDAの登録失敗に関連しています。Call Homeデータに加えて、ファイル「c:\Diagnostics\ExtraData.zip」がアップロードされたバンドルに組み込まれます。

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

次のcmdletは、午前8時15分に記録されたCitrix Supportケース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
<!--NeedCopy-->

次のcmdletは、以前に保存したデータバンドルをアップロードします。

$cred=Get-Credential
C:\PS>Send-CitrixCallHomeBundle –Credential $cred -Path \\mynetwork\myshare\mydata.zip
<!--NeedCopy-->
シトリックス インサイト サービス