構成ログ
注:
Citrix Cloudアカウントでどの言語を選択しても、構成ログの記録は英語でのみ表示されます。これらの記録に関連付けられている日付と時刻は、MM/DD/YY形式で協定世界時 (UTC) で表されます。
構成ログは、Citrix Virtual Apps and Desktops™ および Citrix DaaS (旧称 Citrix Virtual Apps and Desktops service) の展開構成の変更と管理アクティビティをCitrix Cloudのログデータベースにキャプチャする機能です。ログに記録されたコンテンツを使用して、次のことができます。
-
構成変更が行われた後の問題の診断とトラブルシューティング。ログはブレッドクラムトレイルを提供します。
-
変更管理を支援し、構成を追跡します。
-
管理アクティビティを報告します。
このCitrix DaaS™では、構成ログは常に有効になっています。無効にすることはできません。
Studioから、日付範囲または全文検索でフィルタリングして構成ログのコンテンツを表示できます。PowerShellを使用してCSVレポートを生成することもできます。このコンソールから、ログコンテンツを編集または削除することはできません。Remote PowerShell SDKを使用して、ログからの定期的なデータ削除をスケジュールできます。
DaaS構成ログの保持期間を更新
DaaSテナントのパフォーマンスを維持するため、2024年9月9日より、構成ログの保持期間は180日に設定されます。
2024年9月9日時点で180日より古いログは削除されます。単一のDaaSテナントに対するDaaS Limits を拡大し続けるにつれて、この実装は、お客様にとって最高のパフォーマンスと回復力を保証します。
ベストプラクティスとして、四半期ごとのエクスポートメカニズムを設けることをお客様に推奨します。これはPowerShellを介して行うことができます。レポートの生成 を参照してください。また、お客様には定期的なデータ削除をスケジュールすることをお勧めします。定期的なデータ削除のスケジュール を参照してください。
必要な権限 (委任管理 を参照):
-
Citrix Cloud™のフル管理者、およびCitrix DaaSクラウド管理者と読み取り専用管理者は、Studioで構成ログを表示できます。
-
フル管理者とクラウド管理者は、PowerShellを使用してログアクティビティのCSVレポートをダウンロードすることもできます。
ログに記録される内容
次の操作がログに記録されます。
-
管理セクションおよび監視ノードから開始された構成の変更と管理アクティビティ
-
PowerShellスクリプト
-
REST APIリクエスト
注:
データベースのセットアップや管理など、Citrix Cloudプラットフォームの内部操作のログエントリは表示できません。
ログに記録される構成変更の例には、次の操作 (作成、編集、削除、割り当て) が含まれます。
-
マシンカタログ
-
デリバリーグループ (電源管理設定の変更を含む)
-
管理者ロールとスコープ
-
ホストリソースと接続
-
Studioを介したCitrix®ポリシー
ログに記録される管理変更の例は次のとおりです。
-
仮想マシンまたはユーザーデスクトップの電源管理
-
ユーザーにメッセージを送信する機能の管理または監視
次の操作はログに記録されません。（これらの多くは、顧客管理者には利用できません。）
-
プール管理による仮想マシンの電源投入などの自動操作。
-
グループポリシー管理コンソール (GPMC) を介して実装されたポリシーアクション。これらのアクションのログを表示するには、Microsoft ツールを使用します。
-
レジストリを介して、またはStudio、Monitor、PowerShell以外のソースから行われた変更。
構成ログの内容を表示する
構成ログの内容を表示するには、次の手順に従います。
-
Citrix Cloudにサインインします。
-
DaaSタイルで、管理をクリックします。
-
左側のペインでログを選択し、イベントタブをクリックします。
デフォルトでは、イベントログは管理者名で一覧表示されます。必要に応じて、次のタスクを実行できます。
-
表示を並べ替える。 列ヘッダーをクリックして表示を並べ替えます。
-
ログをフィルターする。 次のようなフィルターを設定して表示を絞り込みます。
-
日間隔またはカスタム期間。
-
「メインタスク名」の全部または一部。
-
マシン名やVDI名などの低レベル操作の詳細。低レベルの詳細を検索するには、検索語を入力する前に詳細を含めるように検索範囲を拡張を選択します。注：
-
このオプションを有効にすると、システムがより広範囲のログエントリを検索するため、検索時間が増加する可能性があります。
-
この選択は、現在のWeb Studioセッションに対してのみ保存されます。サインアウトするか、新しいセッションを開始した場合は、検索に低レベルの操作詳細を含めたい場合、再度オプションを選択してください。
-
-
-
ログのエクスポート。 選択したログまたはすべてのログをCSVファイルにエクスポートして、アーカイブまたは詳細な分析を行います。
-
列のカスタマイズ。 クライアント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ログは、コンソールからサインアウトするとクリアされます。（ブラウザウィンドウを更新した場合もクリアされます。）
-
コンソールでのAPI呼び出しを伴う操作はすべて、対応するAPIリクエストがAPIタブに表示されます。
-
表示には、APIリクエストが日付で区切られて時系列順（最新のエントリが最初）に一覧表示されます。表示されるAPIリクエストの最大数は1,000です。
PowerShellログを表示
その日に行ったUIアクションに対応するPowerShellコマンドを表示するには、Logging > PowerShellタブに移動します。
構成ログにメタデータを関連付ける
ログレコードに
MetadataMapというname-valueペアを関連付けることで、構成ログにメタデータを添付できます。
注：
-
メタデータは、高レベルの操作オブジェクトにのみ添付できます。
-
メタデータは、実行時に既存のレコードに関連付けられます。
メタデータを設定する
ログレコードを
MetadataMapに関連付けるには、PowerShellコマンドSet-LogHighLevelOperationMetadataを実行します。 Set-LogHighLevelOperationMetadataは次のパラメーターを受け取ります。
-
Id：高レベル操作のID。
-
InputObject：メタデータを追加する高レベル操作。これは、高レベル操作オブジェクトまたはオブジェクトのリストがPowerShellコマンドに渡される
Idパラメーターの代替です。 -
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:メタデータを追加する上位レベルの操作。これは、上位レベルの操作オブジェクトまたはオブジェクトのリストがPowerShellコマンドに渡される `Id`` パラメーターの代替です。
-
Name: 削除するメタデータのプロパティ名。指定したオブジェクトのすべてのメタデータを削除するには、$null に設定します。
レポートの生成
構成ログデータを含む CSV または HTML レポートを生成するには、Citrix Virtual Apps and Desktops Remote PowerShell SDK の ConfigLogging サービス用の PowerShell コマンドレットを使用します。詳細については、以下を参照してください。
定期的なデータ削除のスケジュール設定
Remote PowerShell SDK を使用して、構成ログデータベースにデータが保持される期間を指定します。（この機能は Studio では利用できません。）Citrix DaaS では、フルアクセスが必要です。
Set-LogSite コマンドレットでは、-LoggingDBPurgeDurationDays パラメーターは、構成ログデータベースにデータが自動的に削除されるまでに保持される日数を指定します。
-
デフォルトでは、このパラメーターの値は 0 です。値が 0 の場合、構成ログデータベースのデータは自動的に削除されません。
-
ゼロ以外の値を設定すると、データベースは 120 分ごとに 1 回チェックされます。保持期間よりも古いデータは削除されます。
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からレポートを生成できます。
-
構成ログのコンテンツを削除することはできません。