Citrix インサイトサービス

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
    • Name: SendExperienceMetrics
    • 値: 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 の左ペインで Settings ノードを選択し、Citrix Customer Experience Improvement Program 設定をオフにします。

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

  • 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日で行われます。

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

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

シトリックス コールホーム

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

Citrix Virtual Apps and Desktops環境では、コールホーム機能はCitrix Telemetry Serviceという名称のバックグラウンドサービスとして動作します。

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

収集されるもの

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

注:

ProgramDataフォルダーは非表示になっています。表示するには、表示 > 表示/非表示 > 隠しファイルをクリックします。

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

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

  • HKEY_LOCAL_MACHINE\SOFTWARE\Citrixの配下にある、Citrix Virtual Apps and Desktopsによって作成されたレジストリ。
  • Windows Management Instrumentation (WMI) information under the Citrix namespace.
  • 実行中のプロセスの一覧。
  • %PROGRAM DATA%\Citrix\CDFに保存されているCitrixプロセスのクラッシュダンプ。
  • インストールおよびアップグレード情報。これには、製品全体のメタインストーラーログ、失敗したMSIログ、MSIログアナライザーからの出力、StoreFront™ログ、ライセンス互換性チェックログ、および予備的なサイトアップグレードテストの結果が含まれる場合があります。

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

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

Call Homeは、Call Home key datapointsに記載されている主要なデータポイントを収集します。

構成と管理の概要

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 は、テレメトリのインストールパス(例えば、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-CitrixCallHome を入力します。有効になっている場合、戻り値は IsEnabled=True および IsMasterImage=False です。

  • マスターイメージから作成されたマシンに対してスケジュールされたアップロードを有効にする: マスターイメージでスケジュールされたアップロードを有効にすると、マシンカタログで作成される各マシンを構成する必要がなくなります。

    Enable-CitrixCallHome -Credential $cred -MasterImage

    スケジュールされたアップロードが有効になっていることを確認するには、Get-CitrixCallHomeと入力します。有効になっている場合、戻り値はIsEnabled=TrueIsMasterImage=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 で、オフをクリックして、選択したマシンのスケジュールをキャンセルします。

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

次の cmdlet を実行した後 (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データをローカルに保存する場合に必要です。
  • 説明と発生時刻: アップロードに関する自由形式の情報。
  • SRNumber: Citrixテクニカルサポートのインシデント番号。
  • Name: バンドルを識別する名前。
  • UploadHeader: CISにアップロードされるアップロードヘッダーを指定するJSON形式の文字列。
  • AppendHeaders: CISにアップロードされる追加ヘッダーを指定するJSON形式の文字列。
  • Collect: 収集または除外するデータを指定するJSON形式の文字列。形式は{‘collector’:{‘enabled’:Boolean}}で、Booleanはtrueまたはfalseです。 有効なコレクター値は次のとおりです。

    • 「WMI」
    • 「プロセス」
    • 「レジストリ」
    • 「クラッシュレポート」
    • 「トレース」
    • 「ファイル」
    • 「MSI」
    • ‘ローカルデータ’
    • ‘サイトデータ’
    • ‘エスエフビー’

    「sfb」を除くすべてのコレクターは、デフォルトで有効になっています。

    「sfb」コレクターは、Skype for Businessの問題を診断するためにオンデマンドで使用するように設計されています。「enabled」パラメーターに加えて、「sfb」コレクターはターゲットユーザーを指定するための「account」および「accounts」パラメーターをサポートしています。次のいずれかの形式を使用してください。

    • この項目は、"{'sfb':{'account':'domain\\\user1'}}" のような形式でアカウント情報を収集することを示します。
    • “-Collect “{‘sfb’:{‘accounts’:[‘domain\\user1’, ‘domain\\user2’]}}”
  • 共通パラメーター: PowerShellのヘルプを参照してください。

以前ローカルに保存されたデータをアップロードする:

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

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

例:

次のコマンドレットは、Call Homeデータ(WMIコレクターからのデータを除く)をCISにアップロードするよう要求します。このデータは、Citrix Provisioning VDAの登録失敗に関連しており、Citrixサポートケース123456について午後2時30分に記録されました。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-->

次のコマンドレットは、午前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
<!--NeedCopy-->

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

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