Citrix DaaS

構成ログ

注:

構成ログレコードは、Citrix Cloudアカウントで選択した言語に関係なく、英語でのみ表示されます。このレコードに関連付けられている日付と時刻は、協定世界時(UTC)のMM/DD/YY形式です。

構成ログは、Citrix Virtual Apps and DesktopsおよびCitrix DaaS(旧称Citrix Virtual Apps and Desktopsサービス)展開の構成の変更と管理活動をCitrix Cloudのログデータベースに記録する機能です。このログは、以下の目的で使用できます:

  • 構成変更の履歴を確認して問題の診断およびトラブルシューティングを行う。ログではブレッドクラムが示されます。
  • 変更管理の補助および構成の追跡を行う。
  • 管理アクティビティのレポートを生成する。

このCitrix DaaSでは、構成ログは常に有効になっています。無効にはできません。

Studioから、構成ログの内容を日付範囲またはフルテキスト検索でフィルタリングして表示できます。また、PowerShellを使用してCSVレポートを生成することもできます。このコンソールでは、ログの内容の編集や削除はできません。Remote PowerShell SDKを使用して、ログから定期的にデータを削除するスケジュールを設定します。

DaaS構成ログの保持の更新

DaaSテナントのパフォーマンスを維持するため、2024年9月9日より構成ログの保持期間が180日に設定されます。

2024年9月9日時点で180日を超えたログは削除されます。単一のDaaSテナントに対するDaaSの制限が拡大し続ける中、この実装により、お客様に最高のパフォーマンスと復元性が保証されます。

ベストプラクティスとして、四半期ごとのエクスポートメカニズムを用意することをお勧めします。これはPowerShellを使用して実行できます。「レポートの生成」を参照してください。また、定期的なデータ削除をスケジュールすることをお勧めします。「定期的なデータ削除のスケジュール」を参照してください。

必要な権限(「委任管理」を参照):

  • Citrix Cloudのすべての管理権限を実行できる管理者、Citrix DaaSのクラウド管理者と読み取り専用管理者は、Studioで構成ログを表示できます。
  • すべての管理権限を実行できる管理者、およびクラウド管理者は、PowerShellを使用してログアクティビティのCSVレポートをダウンロードすることもできます。

ログの内容

次の操作はログに記録されます:

  • Studioコンソールと監視コンソールから開始される構成の変更と管理アクティビティ
  • PowerShellスクリプト
  • REST API要求

注:

Citrix Cloudプラットフォームの内部操作(データベースの設定や管理など)のログエントリは表示できません。

たとえば、以下の項目に対する操作(作成、編集、削除、割り当てなど)が構成ログに記録されます:

  • マシンカタログ
  • デリバリーグループ(電源管理設定の変更を含む)
  • 管理者の役割とスコープ
  • ホストのリソースおよび接続
  • Studioで構成するCitrixポリシー

ログが記録される管理変更の例には次のものがあります:

  • 仮想マシンまたはユーザーのデスクトップの電源管理
  • ユーザーにメッセージを送信する機能の管理または監視

次の操作はログに記録されません。(顧客管理者はこれらの操作の多くを使用できません。)

  • 仮想マシンのプール管理電源オンなどの自動操作。
  • グループポリシー管理コンソール(GPMC)でのポリシー操作。これらの操作のログはMicrosoftのツールを使って表示できます。
  • レジストリによる変更、またはStudio、監視、PowerShell以外での変更。

構成ログの内容の表示

構成ログの内容を表示するには、次の手順に従います:

  1. Citrix Cloudにサインインします。
  2. [DaaS] タイルで、[管理] をクリックします。
  3. 左側のペインで [ログ] を選択し、[イベント] タブをクリックします。

デフォルトでは、中央ペインにログコンテンツが時系列順に(最新のエントリが最初に)表示されます。次の操作を実行できます:

  • 列の見出しで表示を並べ替える。
  • 日間隔またはカスタムの期間を指定したり、[検索] ボックスにテキストを入力したりして、表示をフィルター処理する。検索を使用した後で通常のログ表示に戻すには、[検索] ボックスの文字列をクリアします。
  • 表の右上隅にある 表示する列アイコンを選択して、画面に表示する列を選択します。たとえば、管理者がDaaSにアクセスするために使用するIPアドレスを表示するには、 アイコンをクリックしてクライアントIP列を追加します。

表示特性:

  • 管理および監視中に作成された高レベルの操作は、中央上部のペインに一覧表示されます。高レベル操作により、1つまたは複数のサービスおよびPowerShell SDK呼び出しが実行されます。これは、低レベル操作です。中央上部のペインで高レベル操作を選択すると、下部のペインに低レベル操作が表示されます。
  • PowerShellで親の高レベル操作を指定せずに低レベル操作を作成すると、構成ログにより、代わりの高レベル操作が作成されます。
  • 操作が完了する前に失敗すると、データベースでログ操作が完結しない場合があります。たとえば、開始レコードに対応する停止レコードがないなどです。このような場合、情報不足であることがログに示されます。時間の範囲を指定してログを表示する場合、未完結のログが表示される場合があります。たとえば、直近5日間のログを表示する場合、その5日間に開始時間のみが含まれ、終了時間が含まれていない場合も、その操作のログが表示されます。
  • 注:Citrix Cloudプラットフォームの内部操作(データベースの設定や管理など)のログエントリは表示できません。

マシンカタログ操作に関連するタスクの表示

マシンカタログ操作に関連するタスクを表示するには、[ログ]>[タスク] に移動します。[タスク] タブには、Machine Creation Services(MCS)またはProvisioning Services(PVS)を介して作成されたカタログに関連するタスクのみが表示されます。具体的には、以下のマシンカタログ操作に関連するタスクが表示されます:

  • カタログの作成
  • カタログの複製
  • マシンの追加
  • マシンの削除
  • カタログの更新(イメージまたはマシンの更新)
  • マシン更新のロールバック

ヒント:

[タスク] タブには、プロビジョニングスキームの変更(プロビジョニングスキームの作成または変更)に関連するタスクのみが表示されます。

タスクは以下の状態になります:

  • 完了
  • 未開始
  • 実行中
  • キャンセルされました
  • 失敗
  • 不明

実行中のタスクをキャンセルするには、タスクを選択してから [キャンセル] をクリックします。キャンセルが完了するまでに少し時間がかかります。

ログに記録されたタスクには、次のようなものがあります:

  • 特定のカタログのイメージの更新が完了
  • 特定のカタログのイメージの更新中にエラーが発生
  • 特定のカタログのイメージの更新をキャンセル
  • 特定のカタログへのVMのプロビジョニング
  • 特定のカタログからのVMの削除
  • 特定のカタログを作成

デフォルトでは、ログに記録されたタスクが中央ペインで時系列順に(最新のエントリが最初に)表示されます。列の見出しで表示を並べ替えることができます。完了したタスクをクリアするには、[タスク] タブの [完了したタスクのクリア] をクリックします。画面に表示する列を選択するには、表の右上隅にある表示する列アイコンを選択します。

APIログの表示

REST APIログを表示するには、[ログ]>[API] に移動します。[API] タブには、特定の期間中に行われたREST API要求が表示されます。

次の考慮事項に注意してください:

  • コンソールからサインアウトすると、REST APIログはクリアされます(Webブラウザーウィンドウを更新した場合もクリアされます。)
  • API呼び出しが発生するコンソール操作については、対応するAPI要求が [API] タブに表示されます。
  • 画面には、API要求が時系列順に(最新のエントリが最初に)表示されます。表示されるAPI要求の最大数は1,000です。

PowerShellログを表示する

その日に実行したUI操作に対応するPowerShellコマンドを表示するには、[ログ]>[PowerShell] タブにアクセスします。

メタデータを構成ログに関連付ける

MetadataMapというname-valueペアをログレコードに関連付けることにより、構成ログにメタデータを添付できます。

注:

  • メタデータは高レベルの操作オブジェクトにのみ添付できます。
  • メタデータは、実行時に既存のレコードに関連付けられます。

メタデータを設定する

PowerShellコマンドSet-LogHighLevelOperationMetadataを実行して、ログレコードをMetadataMapに関連付けます。 Set-LogHighLevelOperationMetadataは次のパラメーターを使用します:

  • Id:高レベルの操作のID。
  • InputObject:メタデータを追加する高レベルの操作。これは、Idパラメーターの代わりの方法で、高レベルの操作オブジェクトまたはオブジェクトのリストがPowerShellコマンドに渡されます。
  • Name:追加されるメタデータのプロパティ名。プロパティは、指定された高レベルの操作に対して一意である必要があります。プロパティには次の文字を含めることはできません: ()\/;:#.*?=<>|[]"'
  • Value:プロパティの値。
  • Map:プロパティの(名前、値)ペアのディクショナリ。これは、-Nameおよび-Valueパラメーターを使用してメタデータを設定する代わりの方法です。

たとえば、ID 40のすべての高レベルのログレコードにメタデータを添付するには、次のPowerShellコマンドを実行します:

Get-LogHighLevelOperation – Id 40 | Set-LogHighLevelOperationMetadata -Name A -Value B

ユーザーabc@example.comの高レベルのレコードにメタデータを添付するには、次のPowerShellコマンドを実行します:

Get-LogHighLevelOperation – User `abc@example.com` | Set-LogHighLevelOperationMetadata -Name C -Value D

メタデータを使用して取得する

次のPowerShellコマンドを実行して、関連するメタデータを使用してログレコードを取得します:

  • キーと値で検索:

    Get-LogHighLevelOperation -Metadata "Key:Value"

  • 値と任意のキーで検索:

    Get-LogHighLevelOperation -Metadata "*:Value"

  • キーと任意の値で検索:

    Get-LogHighLevelOperation -Metadata "Key:*"

メタデータを削除する

PowerShellコマンドRemove-LogHighLevelOperationMetadataを実行して、関連するメタデータを削除します。 Remove-LogHighLevelOperationMetadataは次のパラメーターを使用します:

  • Id:高レベルの操作のID。
  • InputObject:メタデータを追加する高レベルの操作。これは、Id`パラメーターの代わりの方法で、高レベルの操作オブジェクトまたはオブジェクトのリストがPowerShellコマンドに渡されます。
  • Name:削除するメタデータのプロパティ名。指定したオブジェクトのすべてのメタデータを削除するには、$nullに設定します。
  • Map:プロパティの(名前、値)ペアのディクショナリ。これは、ハッシュテーブル(@{“name1” = “val1”; “name2” = “val2”} で作成)または文字列ディクショナリ(new-object “System.Collections.Generic.Dictionary[String, String]”で作成)のいずれかです。名前がマップ内のキーと一致するプロパティは削除されます。

レポートの生成

構成ログデータを含むCSVレポートまたはHTMLレポートを生成するには、Citrix Virtual Apps and Desktops Remote PowerShell SDK内のConfigLogging Service用のPowerShellコマンドレットを使用します。詳しくは、次のページを参照してください:

定期的なデータ削除のスケジュール

Remote PowerShell SDKを使用して、構成ログデータベースでデータが維持される期間を指定します。(この機能はStudioでは使用できません。)Citrix DaaSでは、フルアクセス権が必要です。

Set-LogSiteコマンドレットの-LoggingDBPurgeDurationDaysパラメーターは、構成ログデータベースから自動的に削除されるまでデータが維持される日数を指定します。

  • デフォルトでは、このパラメーターの値は0です。値がゼロの場合、構成ログデータベースのデータは自動的に削除されません。
  • ゼロ以外の値を設定すると、データベースは120分ごとに確認され保有期間より古いデータは削除されます。

Get-LogSiteを使用して、パラメーターの現在値を表示します。

オンプレミスCitrix Virtual Apps and Desktopsとの相違点

オンプレミスのVirtual Apps and Desktops製品の構成ログを使い慣れている場合は、Citrix Cloudバージョンにはいくつかの違いがあることに注意してください。Citrix Cloudの場合:

  • 構成ログは常に有効になっています。無効にはできません。必須ログは使用できません。
  • 構成ログデータベースはCitrix Cloudプラットフォームで管理されるため、構成ログデータベースの場所を変更することはできません。
  • 構成ログの表示には、Citrix Cloudプラットフォーム内で実行される操作やアクティビティは含まれません。
  • ログに記録された操作のCSVまたはHTMLレポートを作成できるのは、PowerShellのみです。オンプレミス製品では、Citrix StudioまたはPowerShellからレポートを生成できます。
  • 構成ログの内容は削除できません。