Citrix Insight Services

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コンポーネントを展開またはアップグレードする場合、インストールプロセスに関する匿名の情報が、コンポーネントをインストール/アップグレードするマシンで収集および保存されます。このデータは、インストールに関するカスタマーエクスペリエンス向上のために使用されます。詳しくは、「https://more.citrix.com/XD-INSTALLER」を参照してください。

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

このデータの自動アップロードは、全製品インストーラーのグラフィックおよびコマンドラインインターフェイスの両方で、デフォルトで有効です。

  • デフォルト値はレジストリ設定で変更できます。インストール/アップグレードの前にレジストリ設定を変更すると、全製品インストーラーの使用時にその値が使用されます。
  • コマンドラインインターフェイスを使用して、コマンドにオプションを指定してインストール/アップグレードする場合、デフォルト設定をオーバーライドできます。

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

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

    • 場所:HKEY_LOCAL_MACHINE\Software\Citrix\MetaInstall
    • 名前:SendExperienceMetrics
    • 値:0 = 無効、1 = 有効
  • 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カスタマーエクスペリエンス向上プログラム

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

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

CEIPには、サイトの作成時に自動で登録されます(最初のDelivery Controllerのインストール後)。サイトの作成からおよそ7日後に、初回データアップロードが行われます。登録は、サイトの作成後にいつでも取り消すことができます。Studioのナビゲーションペイン([製品サポート]タブ)で [構成] ノードを選択してガイダンスに従って操作します。

Citrix Virtual Apps and Desktops環境をアップグレードする場合:

  • CEIPをサポートしないバージョンからアップグレードする場合、参加するかどうかを確認するメッセージが表示されます。
  • CEIPをサポートするバージョンからアップグレードし、参加が有効になっていた場合、CEIPはアップグレードしたサイトで有効になります。
  • CEIPをサポートするバージョンからアップグレードし、参加が無効になっていた場合、CEIPはアップグレードしたサイトで無効になります。
  • CEIPをサポートするバージョンからアップグレードし、参加が不明な場合、参加するかどうかを確認するメッセージが表示されます。

収集された情報は匿名になるため、Citrix Insight Servicesへのアップグレード後は表示されません。

VDAのインストール時の登録

デフォルトでは、ユーザーはWindows VDAのインストール時にCEIPに自動登録されます。このデフォルトはレジストリ設定で変更できます。VDAインストールの前にレジストリ設定を変更すると、その値が使用されます。

CEIPへの自動登録を制御するレジストリ設定(デフォルト = 1):

場所:HKEY_LOCAL_MACHINE\Software\Citrix\Telemetry\CEIP 名前:Enabled 値:0 = 無効、1 = 有効

デフォルトでは、レジストリにEnabledプロパティは表示されません。未指定のままの場合、自動アップロード機能は有効です。

PowerShellを使用する場合、次のコマンドレットはCEIPへの登録を無効にします。

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

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

VDAのインストールからおよそ7日後に、初回データアップロードが行われます。

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

CEIPへは、関連するCitrix製品、コンポーネント、テクノロジ(Citrix Provisioning、AppDNA、Citrixライセンスサーバー、Windows向けCitrix Workspaceアプリ、ユニバーサルプリントサーバー、Session Recording)のインストール時にも参加できます。インストールと参加のデフォルト値について詳しくは、該当のドキュメントを参照してください。

Citrix Call Home

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://more.citrix.com/XD-CALLHOME」を参照してください。

Citrix Scoutでは、Call Homeのスケジュール機能も使用できます。詳しくは、「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では以下の情報も収集されます:

  • Citrix Virtual Apps and DesktopsによってHKEY\_LOCAL\_MACHINE\\SOFTWARE\\Citrixに作成されたレジストリ
  • Citrix名前空間のWindows Management Instrumentation(WMI)情報
  • 実行中のプロセス一覧
  • %PROGRAM DATA%\Citrix\CDFに保存されているCitrixプロセスのクラッシュダンプ
  • インストールとアップグレードの情報これには、製品全体のMetainstallerログ、失敗したMSIログ、MSIログアナライザーからの出力、StoreFrontログ、ライセンスの互換性チェックログ、サイトの事前アップグレードテストの結果が含まれます。

トレース情報は収集時に圧縮されます。Citrix Telemetry Serviceは、最長8日間、圧縮されたトレース情報を最大10MB保持します。

  • データを圧縮することで、Call HomeのVDA上の占有領域を小さくできます。
  • プロビジョニングされたマシンでのIOPを避けるため、トレースはメモリで保持されます。
  • トレースバッファでは、循環メカニズムを使用してトレースがメモリで保持されます。

Call Homeは「Call Homeキーデータポイント」に記載されたキーデータポイントを収集します

サマリーの構成と管理

全製品インストールウィザードの使用時、またはそれ以降に、PowerShellコマンドレットを使用して、Call Homeに登録することができます。登録すると、デフォルトで、ローカルタイムの毎日曜日午前3時頃に診断情報が収集され、Citrixにアップロードされます。アップロードは、指定された時間の前後2時間以内に行われます。つまり、デフォルトのスケジュールの場合、アップロードは午前3時から午前5時の間に行われます。

診断情報をスケジュールベースでアップロードしない場合(またはスケジュールを変更する場合)は、PowerShellコマンドレットを使用して診断情報を手動で収集し、アップロードするかローカルに保存してください。

Call Homeのスケジュールによるアップロード登録する場合、および診断情報を手動でCitrixにアップロードする場合は、CitrixのアカウントまたはCitrix Cloudの資格情報を入力します。Citrixは、アカウント資格情報を、顧客の識別とデータのアップロードに使用されるアップロードトークンに交換します。アカウント資格情報は保存されません。

アップロードが実行されると、Citrixアカウントに関連付けられたアドレスに通知メールが送信されます。

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

前提条件

  • PowerShell 3.0またはそれ以降が実行されている必要があります。
  • Citrix Telemetry Serviceが実行されている必要があります。
  • システム変数PSModulePathは、C:\Program Files\Citrix\Telemetry Service\などの、Telemetryのインストールパスに設定する必要があります。

コンポーネントインストール時のCall Homeの有効化

VDAのインストールまたはアップグレード時: 全製品インストーラーのグラフィカルインターフェイスを使用してVirtual Delivery Agentをインストールまたはアップグレードする場合には、Call Homeに参加するかどうかを確認するメッセージが表示されます。2つのオプションがあります。

  • Call Homeに参加します。
  • 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
    

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

例:

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

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

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

以下のコマンドレットでは、毎週水曜日の午後11時20分にデータを収集してアップロードするスケジュールが作成されます。

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

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

Call Homeの無効化

Call Homeを無効にするには、PowerShellコマンドレットかCitrix Scoutを使用します。

AOTログは、Call Homeのスケジュールによるアップロードが無効な場合でも収集されディスクに保存されます。(スケジュールによるアップロードが無効な場合、AOTログは自動的にシトリックスにアップロードされません。)AOTログの収集およびローカル保存は無効化できます。

PowerShellでCall Homeを無効にする

以下のコマンドレットを実行すると、診断データは自動的にシトリックスにアップロードされません。(キャンセル後も、Citrix ScoutまたはTelemetryのPowerShellコマンドレットを使用した診断データのアップロードは実行できます)。

Disable-CitrixCallHome

Call Homeが無効になったことを確認するには、Get-CitrixCallHomeを入力します。無効な場合は、「IsEnabled=False」および「IsMasterImage=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. Webブラウザーにプロキシサーバー情報を追加します。Internet Explorerで、[インターネットオプション]>[接続]>[LANの設定]の順に選択します。[LANにプロキシサーバーを使用する] をオンにして、プロキシサーバーのアドレスとポート番号を入力します。

  2. PowerShellで「netsh winhttp import proxy source=ie」を実行します。

    プロキシサーバー構成時のnetshコマンドの実行例

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

    TelemetryService.exeファイルへのプロキシ情報の追加

  4. Telemetry Serviceを再起動します。

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

手動による診断情報の収集およびアップロード

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

CIS Webサイトを使用してバンドルをアップロードするには、以下の手順に従います。

  1. Citrixのアカウント資格情報を使用してCitrix Insight Servicesにログオンします。
  2. [My Workspace] を選択します。
  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>]

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

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

使用できるパラメーターは次のとおりです。

  • Credential: アップロード先をCISに設定します。
  • InputPath: パッケージに含めるzipファイルの場所。これは、Citrixサポートから要求される追加ファイルである可能性があります。拡張子.zipを含めてください。
  • OutputPath: 診断情報を保存する場所。このパラメーターは、Call Homeデータをローカルに保存するときに必要です。
  • DescriptionおよびIncident Time: アップロードに関する自由形式の情報。
  • SRNumber: Citrixテクニカルサポートのインシデント番号。
  • Name: パッケージの識別名。
  • UploadHeader: CISにアップロードするアップロードヘッダーを指定する、JSON形式の文字列。
  • AppendHeaders: CISにアップロードする追加ヘッダーを指定する、JSON形式の文字列。
  • Collect: 「{‘collector’:{‘enabled’:Boolean}}」の形で、どのデータを修正または省略するかを指定するJSON形式の文字列。ここで、Booleanはtrueまたはfalseです。 有効なcollectorの値は以下のとおりです。

    • ‘wmi’
    • ‘process’
    • ‘registry’
    • ‘crashreport’
    • ‘trace’
    • ‘file’
    • ‘msi’
    • ‘localdata’
    • ‘sitedata’
    • ‘sfb’

    デフォルトでは、’sfb’以外のすべてのcollectorが有効です。

    ‘sfb’ collectorは、Skype for Businessの問題を診断するためにオンデマンドで使用するよう設計されています。’sfb’ collectorは、’enabled’パラメーターに加えて、ターゲットユーザーを指定する’account’パラメーターと’accounts’パラメーターをサポートします。以下のいずれかの形式を使用します。

    • “-Collect “{‘sfb’:{‘account’:’domain\\user1’}}”
    • “-Collect “{‘sfb’:{‘accounts’: [‘domain\\user1’, ‘domain\\user2’]}}”
  • CommonParameters: PowerShellのヘルプを参照してください。

ローカルに保存されているデータをアップロードする:

Send-CitrixCallHomeBundle -Credential <PSCredentia\> -Path string [<CommonParameters>]

Pathパラメーターにより、以前保存されたパッケージの場所を指定します。

例:

以下のコマンドレットでは、(WMIコレクターからのデータを除く)Call HomeデータのCISへのアップロードが要求されます。このデータは、午後2時30分にCitrixサポートケース123456で記録された、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'}"

以下のコマンドレットでは、午前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