Citrix DaaS™

配置日志记录

注意:

配置日志记录仅以英文显示,无论您为 Citrix Cloud 帐户选择哪种语言。这些记录关联的日期和时间采用 MM/DD/YY 格式,以协调世界时 (UTC) 表示。

配置日志记录是一项功能,用于捕获 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 报告。

记录的内容

将记录以下操作:

  • Manage(管理)部分和 Monitor(监视)节点启动的配置更改和管理活动
  • PowerShell 脚本
  • REST API 请求

注意:

您无法查看 Citrix Cloud 平台内部操作的日志条目,例如数据库设置和管理。

记录的配置更改示例包括处理(创建、编辑、删除、分配)以下内容:

  • 计算机目录
  • 交付组(包括更改电源管理设置)
  • 管理员角色和作用域
  • 主机资源和连接
  • 通过 Studio 进行的 Citrix® 策略

记录的管理更改示例包括:

  • 虚拟机或用户桌面的电源管理
  • 管理或监视功能向用户发送消息

以下操作未记录。(其中许多操作不适用于客户管理员。)

  • 自动操作,例如池管理虚拟机的电源开启。
  • 通过组策略管理控制台 (GPMC) 实施的策略操作。使用 Microsoft 工具查看这些操作的日志。
  • 通过注册表或 Studio、Monitor 或 PowerShell 以外的源进行的更改。

查看配置日志内容

要查看配置日志内容,请执行以下步骤:

  1. 登录 Citrix Cloud
  2. DaaS 磁贴中,单击 Manage(管理)。
  3. 在左侧窗格中选择 Logging(日志记录),然后单击 Events(事件)选项卡。

默认情况下,事件日志按管理员名称列出。您可以根据需要执行以下任务:

  • 排序显示。 通过单击列标题对显示进行排序。
  • 筛选日志。 通过设置筛选条件(例如日期间隔或自定义期间)或在“搜索”框中输入完整或部分“主任务”名称来优化显示。要在使用搜索后返回标准显示,请清除“搜索”框中的文本。
  • 导出日志。 将选定或所有日志导出到 CSV 文件以进行存档或进一步分析。
  • 自定义列。 通过添加非默认列(例如 Client IP 和 Labels)来根据您的需要调整显示。
  • 管理标签。 为事件日志添加、编辑和删除标签,以增强日志组织和跟踪。

显示特征:

  • 在管理和监视期间创建的高级操作列在中间上方窗格中。高级操作会生成一个或多个服务和 PowerShell SDK 调用,这些是低级操作。当您在中间上方窗格中选择一个高级操作时,下方窗格将显示低级操作。
  • 如果您在 PowerShell 中创建低级操作时未指定父高级操作,则配置日志记录会创建一个替代高级操作。
  • 如果操作在完成之前失败,则日志操作可能无法在数据库中完成。例如,开始记录没有相应的停止记录。在这种情况下,日志指示缺少信息。当您根据时间范围显示日志时,如果日志中的数据与条件匹配,则会显示不完整的日志。例如,如果您请求过去五天的日志,并且过去五天内开始时间有日志但没有结束时间,则该日志将包含在内。
  • 请记住:您无法查看 Citrix Cloud 平台内部操作的日志条目,例如数据库设置和管理。

查看与计算机目录操作相关的任务

要查看与计算机目录操作相关的任务,请导航到 Logging > Tasks(日志记录 > 任务)。Tasks(任务)选项卡仅显示与通过 Machine Creation Services™ (MCS) 或 Provisioning Services (PVS) 创建的目录相关的任务。具体而言,将显示与以下计算机目录操作相关的任务:

  • 创建目录
  • 克隆目录
  • 添加计算机
  • 删除计算机
  • 更新目录(更新映像或计算机)
  • 回滚计算机更新

提示:

Tasks(任务)选项卡仅显示与预配方案更改(创建或修改预配方案)相关的任务。

任务可以处于以下状态:

  • 已完成
  • 未开始
  • 正在运行
  • 已取消
  • 失败
  • 未知

要取消正在运行的任务,请选择该任务,然后单击 Cancel(取消)。取消需要一些时间才能完成。

记录的任务示例包括:

  • 某个目录的映像更新已完成
  • 更新某个目录的映像时出错
  • 某个目录的映像更新已取消
  • 将 VM 预配到某个目录
  • 从某个目录中删除 VM
  • 已创建某个目录

默认情况下,中心窗格中的显示按时间顺序(最新条目在前)列出记录的任务,并按日期分隔。您可以按列标题对显示进行排序。要清除已完成的任务,请在 Tasks(任务)选项卡下单击 Clear Completed Tasks(清除已完成的任务)。要选择要在显示中显示的列,请选择表格右上角的 Columns to Display(要显示的列)图标。

查看 API 日志

要查看 REST API 日志,请导航到 Logging > APIs(日志记录 > API)。APIs(API)选项卡显示在特定时间段内发出的 REST API 请求。

请注意以下注意事项:

  • REST API 日志在您注销控制台后会被清除。(如果您刷新浏览器窗口,它们也会被清除。)
  • 控制台中导致 API 调用的任何操作都会在 APIs(API)选项卡上显示其相应的 API 请求。
  • 显示按时间顺序(最新条目在前)列出 API 请求,并按日期分隔。显示中 API 请求的最大数量为 1,000。

查看 PowerShell 日志

要查看与您当天执行的 UI 操作相对应的 PowerShell 命令,请导航到 Logging > PowerShell(日志记录 > PowerShell)选项卡。

将元数据与配置日志关联

您可以通过将名为 MetadataMapname-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 cmdlet。有关详细信息,请参阅:

安排定期数据删除

使用 Remote PowerShell SDK 指定配置日志记录数据库中数据的保留时间。(此功能在 Studio 中不可用。)在 Citrix DaaS 中,您必须具有完全访问权限。

Set-LogSite cmdlet 中,-LoggingDBPurgeDurationDays 参数指定配置日志记录数据库中数据在自动删除之前保留的天数。

  • 默认情况下,此参数的值为 0。零值表示配置日志记录数据库中的数据永远不会自动删除。
  • 当您设置非零值时,数据库每 120 分钟检查一次。早于保留期限的数据将被删除。

使用 Get-LogSite 查看参数的当前值。

与本地 Citrix Virtual Apps and Desktops 的差异

如果您熟悉本地 Virtual Apps and Desktops 产品中的配置日志记录,则 Citrix Cloud 版本存在一些差异。在 Citrix Cloud 中:

  • 配置日志记录始终处于启用状态。您无法将其禁用。强制日志记录不可用。
  • 您无法更改配置日志记录数据库的位置,因为该数据库在 Citrix Cloud 平台中进行管理。
  • 配置日志显示不包括在 Citrix Cloud 平台中执行的操作和活动。
  • PowerShell 是您创建日志操作的 CSV 或 HTML 报告的唯一选择。在本地产品中,可以从 Citrix Studio 或 PowerShell 生成报告。
  • 您无法删除配置日志内容。