Citrix Virtual Apps and Desktops™ 遥测数据元素
代理
使用情况
标头
| 键 | 描述 | 示例 |
|---|---|---|
| ver | 指示遥测事件的版本。 | 1 |
| id | 指示使用情况事件的唯一标识符。 | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | 指示 Citrix Analytic Service 用于识别云使用情况事件的事件类型。 | SendBrokerTelemetryData |
| st | 指示事件在代理中生成时的时间戳。 | 2011-08-12T20:17:46.384Z |
| prod
|
标识使用情况事件的源产品和部署。
|
XenDesktop.Broker (Cloud)
OnPrem.Broker (OnPrem) |
| prodVer | 指示 Citrix DaaS/Citrix Virtual Apps and Desktops 产品版本。 | 7.25.0.0 |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| TotalPublishedApps | 指示已发布的应用程序总数。 | 10 |
| TotalPublishedDesktops | 指示已发布的桌面总数。 | 10 |
| VDAs.Total | 指示 VDA 总数。 | 10 |
| VDAs.OSTypes | 指示按操作系统类型(例如 Windows、Linux 和 Mac)划分的 VDA 总数。 | 10 |
| VDAs.OSVersions | 指示按操作系统版本(例如 Windows 10、11、2022、2019)划分的总数。 | 10 |
| VDAs.HostingLocations.Azure | 指示每个受支持的托管位置(例如 Azure、AWS、GCP、Nutanix、VMWare、XenServer 和 HyperV)的 VDA 数量。
|
10
|
| VDAs.HostingLocations.AWS | ||
| VDAs.HostingLocations.Nutanix | ||
| VDAs.HostingLocations.VMWare | ||
| VDAs.HostingLocations.XenServer | ||
| VDAs.HostingLocations.HyperV | ||
| VDAs.ProvisionedMethod.MCS | 指示由 Machine Creation Service (MCS) 预配的计算机数量。 | 10 |
| VDAs.ProvisionedMethod.ManualOr3P | 指示手动或由 3P 预配的计算机数量。 | 10 |
| VDAs.SessionSupport.StaticSingle | 指示静态分配的单会话计算机数量。 | 10 |
| VDAs.SessionSupport.DynamicSingle | 指示动态分配的单会话计算机数量。 | 10 |
| VDAs.SessionSupport.Multi | 指示多会话计算机总数。 | 10 |
| VDAs.RemotePCAccess.Windows | 指示按操作系统类型(Windows、Mac、Linux)划分的远程电脑访问计算机数量。
|
10
|
| VDAs.RemotePCAccess.Linux | ||
| VDAs.RemotePCAccess.MacOS | ||
| VDAs.ActiveSessionRecordingAgents | 指示具有活动会话录制代理的 VDA 数量。 | 5 |
| VDAs.Subscriptions | 指示 VDA 的公共云订阅数量。 | 2 |
| VDAs.LocationTypes | 指示 VDA 的位置类型数量。 | 2 |
| AutoScale.DGWithAutoscaleEnabled | 指示启用了 Autoscale 的交付组数量。 | 2 |
| AutoScale.TotalMachinesCtrlByAutoscale | 指示由 Autoscale 控制的计算机数量。 | 5 |
| AutoScale.VerticalAutoscaleEnabledByDGandSite | 指示按 DG 和站点启用了 Vertical Autoscale 的计算机数量。 | 2 |
| AutoScale.TaggedBasedAutoscaledDG | 指示基于标记的自动缩放交付组数量。 | 2 |
| DeliveryGroup.TotalRebootSchedulesEnabled | 指示启用了 Reboot Schedules 的交付组数量。 | 2 |
| DeliveryGroup.Total | 指示交付组总数。 | 10 |
| Policy.TotalPolicySets | 指示策略集数量。 | 3 |
| Policy.TotalPolicies | 指示组策略数量。 | 2 |
| Policy.TotalPolicySettings | 指示组设置数量。 | 2 |
| PublishedPackageApps.AppVSingleAdmin | 指示在 AppV 单管理员模式下发布的打包应用程序总数。 | 2 |
| PublishedPackageApps.AppVDualAdmin | 指示在 AppV 双管理员模式下发布的打包应用程序总数。 | 2 |
| PublishedPackageApps.Msix | 指示在 MSIX 模式下发布的打包应用程序总数。 | 2 |
| PublishedPackageApps.AppAttach | 指示在 AppAttach 模式下发布的打包应用程序总数。 | 2 |
| PublishedPackageApps.FlexApp | 指示在 FlexApp 模式下发布的打包应用程序总数。 | 2 |
会话
标头
| 字段 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用情况事件的版本。 | 1 |
| id | 指示使用情况事件的唯一标识符。 | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | 指示 Citrix Analytic Service 用于识别云使用情况事件的事件类型。 | Cloud.Licensing |
| st | 指示事件在代理中生成时的时间戳。 | 2011-08-12T20:17:46.384Z |
| prod
|
标识使用情况事件的源产品和部署。
|
XenDesktop.Broker (Cloud)
OnPrem.Broker (OnPrem) |
| prodVer | 指示 Citrix DaaS 或 Citrix Virtual Apps and Desktops 产品版本。 | 7.25.0.0 |
| user
|
标识用于唯一标识启动会话的用户 ID。该值已加扰。
|
fullName: C648FE671A44B3F7 (始终加扰)
samName:C758LH671A44B3F7 (始终加扰) upn: C7948FE671A44B3F7 (始终加扰) userLicenseId:C265FE671A44B3F7 (始终加扰) userSid: C097FE671A44B3F7 (始终加扰) |
| tenant -> id | 指示 Citrix Cloud™ 帐户的客户 ID。对于本地部署,此字段不适用且无值。 | joj1mh0598tj |
| dvc -> dvcId | 指示用于唯一标识启动会话的设备的设备 ID。 | AE18C4D5 |
| dvc -> dvcName | 指示设备的友好名称。该值已加扰。 | C758LH671A44B3F7 (始终加扰) |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| appProtectionKeyLoggingRequired | 指示会话是否在启用了键盘记录保护的情况下启动。 | False |
| appProtectionScreenCaptureRequired | 指示会话是否在启用了屏幕捕获保护的情况下启动。 | False |
| cspTenantCustomerId | 指示 CSP 租户的 Citrix Cloud 帐户的客户 ID。对于本地部署,此字段不适用且无值。 | 6c2vtxgxyftt |
| isAnonymousUser | 指示是否启动了未经身份验证的会话。 | False |
| licenseActivityTimeStamp | 指示生成有效负载时的时间戳。 | 2011-08-12T20:17:46.384Z |
| licenseActivityType | 指示许可事件类型。此字段指示许可事件类型是用于分配还是释放操作。 | Connect |
| licenseModel | 指示部署的许可证模型。 | UserDevice |
| productEdition | 指示部署的产品版本。 | Premium |
| productId | 指示部署中产品的产品 ID。 | CAVDS |
| protocol | 指示用于启动会话的协议。 | HDX™ |
| sessionKey | 指示会话的唯一标识符。 | uq390c5fc3-86eb-4df3-bd9a-f4a8fed2c9e2 |
| sessionSupport | 指示会话支持类型。 | SingleSession |
| sessionType | 指示会话类型。 | Application |
| ver | 指示有效负载版本。 | 1.3 |
| workerSid | 指示用于会话的 VDA 的唯一标识符。该值已加扰。 | 1E5LH671A44B3F7 (始终加扰) |
| isWindows365 | 指示会话是否为 Windows 365 启动。 | True |
| entitlementType | 指示客户的许可证授权类型。 | Production |
| siteId | 指示站点的唯一标识符。 | a35647d0-901c-4477-87e0-dcd781d455f4 |
| desktopGroupId | 指示桌面或交付组的唯一标识符。 | e9d859dc-1bfc-4b3e-bad3-41806bb4e694 |
| clientType | 指示 Citrix Workspace™ 应用程序类型。 | Windows |
| clientVersion | 指示 Citrix Workspace 应用程序版本。 | 23.5.1.83 |
| workerCloudType | 指示用于 VDA 预配的公共云类型。 | Azure |
| enabledFeatures | 指示会话中启用的功能。例如,在启用了 AppProtectionScreenCaptureRequired 和 SessionRecording 的会话中,此字段的值为 66。 |
66 |
| launchRequestSource
|
记录用于请求启动的产品。它可以是本地 StoreFront™ 或云 StoreFront。
|
0 (StoreFront or 3P) |
| 1 (Workspace) | ||
| isEvents | 指示 中的严重故障。 | 无法创建 ST 数据库。 |
| heartBeatTime | 指示许可证服务器到 CIS 或 Citrix Analytic Service 的心跳时间。 | 1689058813 |
| vdaTelemetry
|
指示为 App Layering、用户个性化层、用户配置文件管理、Workspace Environment Management™ 和 HDX 功能捕获的有效负载。
|
vdaTelemetry
SessionTelemetry CPM_feature: 32 HDX1: 66 HDX2: 0 MachineTelemetry AL_productVersion: 23.12.0.1001 UPL_isEnabled: 1 CPM_version: 22.3.4000 wem_enableMethod: 1 wem_agentVersion: 2402.1 |
Studio
用法
标头
| 字段 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用事件的版本。 | 1 |
| id | 指示使用事件的唯一标识符。 | 8c2e20a5-ca3f-4401-ad69-d037933c40a0 |
| type | 指示 Citrix Analytic Service 用于识别云使用事件的事件类型。 | Studio.Usage |
| st | 指示事件在 Studio 中生成时的时间戳。 | 2024-03-22T01:32:23.4056195Z |
| prod | 标识使用事件的源产品和部署。 | XenDesktop.Studio |
| prodVer | 指示 Citrix DaaS/Citrix Virtual Apps and Desktops 产品版本。 | 7.42.0.0 |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| AdminLoginList | 指示唯一管理员的 SamAccountName 列表。该值已混淆。 | {AdminLoginList: [UFMJ+JvXOTHO9mQDsOweiw= =]}(始终混淆) |
| TotalApiRequests | 指示 Orchestration 服务的 API 请求。 | {TotalApiRequests: 1000} |
| BackupCount | 指示 Studio 管理员执行的备份计数。 | {BackupCount: 200} |
| RestoreCount | 指示 Studio 管理员执行的还原计数。 | {RestoreCount: 20} |
Director
使用情况报告
标头
| 字段 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用情况事件的版本。 | 1 |
| id | 指示使用情况事件的唯一标识符。 | 8c2e20a5-ca3f-4401-ad69-d037933c40a0 |
| type | 指示 Citrix Analytic Service 用于识别云使用情况事件的事件类型。 | Telemetry |
| st | 指示在 Studio 中生成事件的时间戳。 | 2024-03-22T01:32:23.4056195Z |
| prod | 标识使用情况事件的原始产品和部署。 | XenApp.Monitor |
| prodVer | 指示 Director 产品版本。 | 7.42.0.0 |
| dvcName | 服务器名称 | C758LH671A44B3F7 |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| AdminLoginCount
|
这是有效负载的一部分,提供管理员登录的计数。
|
type: AdminLogin
stats 0: 1 1: 7 |
| FeatureUsageCount
|
有效负载的此部分包含 Director 中使用的主要功能计数。
|
type: FeatureUsage
stats 0: 15 1: 20 5: 10 |
| OdataUsageCount
|
有效负载的此部分包含 OData API 使用计数
|
type: OData_v3
stats 0: 1 2: 7 5: 9 type: OData_v4 stats 0: 1 2: 8 6: 7 |
| AppUsage
|
指示已发布应用程序的每周使用情况指标。
|
type: AppUsage
headers: applicationName,processName,totalDurationInMinutes period: 01/05/24-07/05/24 values: [ Calc_AWTSVDA-1907R,calc.exe,0.13, Notepad_AWTSVDA-1907R,notepad.exe,4] |
| UniqueAppUsers
|
指示已发布应用程序的唯一用户计数以及每月总应用程序启动次数。
|
type: UniqueAppUsers
headers: applicationName,totalLaunches,totalUniqueUsers period: 04/24 values: [ Calc_AWTSVDA-1907R,100,10, Notepad_AWTSVDA-1907R,200,20] |
| DesktopUsage
|
指示已发布桌面的每周使用情况指标。
|
type: DesktopUsage
headers: desktopGroupName,sessionSupport,totalDurationInMinutes period: 01/05/24-07/05/24 values: [ RdsDesktopAndAppGroup,1,10] |
| UniqueDesktopUsers
|
指示已发布桌面的唯一用户计数以及每月总启动次数。
|
type: UniqueDesktopUsers
headers: desktopGroupName,totalLaunches,totalUniqueUsers period: 04/24 values: [ RdsDesktopAndAppGroup,10,5] |
| AvgLogonDuration
|
指示平均登录持续时间。
|
type: AvgLogonDuration
headers: totalUserLogons, avgLogonDurationInSeconds period: 01/05/24-07/05/24 values: [ 200,4] |
| CostSaved
|
指示客户每月节省的成本。
|
type: CostSaved
headers: hypervisor,costSaved,currency period: 04/24 values: [ 1,221.02,1 2,301.02,2] |
Storefront Configuration
使用情况
标头
| 字段 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用情况事件的版本 | 1.0 |
| id | 指示使用情况事件的唯一标识符 | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | 指示 CAS 用于识别云使用情况事件的事件类型 | Configuration |
| st | 指示在 StoreFront 中生成事件的时间戳 | 2011-08-12T20:17:46.384Z |
| prod | 标识使用情况事件的原始产品和部署 | OnPrem.StoreFront |
| prodVer | 指示 StoreFront 版本(内部) | 3.30.0.0 |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| serverName | 指示 StoreFront 运行所在服务的 hostname | storefront-01.storefront.local |
| deploymentId | 指示 StoreFront 部署的唯一标识符 | f47ac10b-58cc-4372-a567-0e02b2c3d479 |
| installedWithCVAD | 指示 StoreFront 是否与 CVAD 一同安装 | false |
| cpuCores | 指示 CPU 内核总数 | 4 |
| cpuModel | 指示运行 StoreFront 的 CPU | 12th Gen Intel(R) Core(TM) i7-1255U 1.70 GHz |
| ramGb | 指示总 RAM 量(以 GB 为单位) | 16 |
| numServersInGroup | 指示服务器组中的服务器数量 | 3 |
| stores | 指示 StoreFront Store 配置 JSON blob。Store 对象的数组。某些值已混淆 | 示例 |
| rfWebSites | 指示 StoreFront RFWeb 配置 JSON blob。RFWeb 配置对象的数组 | 示例 |
| gateways | 指示网关配置对象(JSON blob 格式)。网关对象的数组 | 示例 |
| authServices | 指示身份验证服务配置对象(JSON blob 格式)。身份验证服务对象的数组 | 示例 |
| IsPiiScrambled | true | |
字段 stores 示例
[{
"BaseUrl": "baseUrl",
"StorePath": "/",
"EnabledFeatures": 21 bit bitmap,
"ResourceTypeFilteringEnabled": "disabled|Citrix.MPS.Application;Citrix.MPS.Desktop",
"DefaultRfWebSite": "/Citrix/StoreWeb",
"GatewaysUsed": [
"gatewayId"
],
"VdaLogonDataProvider": "",
"ResourceFeeds": [
{
"FeedName": "<resourceFeedName>|scrambled",
"Type": "CVAD",
"LoadBalancingEnabled": true,
}
],
"AdvancedAggregation": {
"Enabled": true,
"GroupingCount": 1,
"ControllersPushIdenticalResources": true,
"LoadBalanced": true,
"AnyPrimaryFarms": true,
"AnyBackupFarms": true,
}
}]
<!--NeedCopy-->
如果未找到任何 Store,则它将是一个空数组 []。
字段 rfWebSites 示例
[{
"SiteId": "siteId",
"BaseUrl": "baseUrl",
"StorePath": "storePath",
"UiExperienced": 0,
"EnabledFeatures": 9 bit,
"AuthMethodsEnabled": [
"ad"
],
"CanUsersDownloadApps": {
"Enabled": true,
"Windows": "exe",
"MacOS": "dmg"
},
"WorkspaceControl": {
"Enabled": true,
"LogoffAction": 0,
"AutoReconnectAtLogon": true,
"ShowReconnectButton": true,
"ShowDisconnectButton": true
},
"MultiClickTimeout": 1,
"UiViews": [
"apps",
"desktops"
],
"DefaultTab": 0,
}]
<!--NeedCopy-->
如果未找到 rfWebSites,则它将是一个空数组 []。
网关字段示例
[{
"GatewayId": "gatewayId",
"IsCloudGateway": true,
"LoadBalancingSTAEnabled": true,
"SessionReliabilityEnabled": true,
"RequestTicketsFromTwoSTA": true,
"Version": "1234",
"LogonType": "domain",
"SmartCardFallbackEnabled": true
}]
<!--NeedCopy-->
如果未找到网关,则它将是一个空数组 []。
身份验证服务字段示例
[{
"SiteId": "SiteId",
"Store": "StoreAuth",
"AuthMethodsEnabled": [
"ad"
],
"PasswordChangeWhenExpired": 0,
"PasswordRemindersForm": 1,
"DelegateCredentialValidationToCitrix": true,
"ValidatePasswordsOnDeliveryControllers": true
}]
<!--NeedCopy-->
如果未找到身份验证服务,则它将是一个空数组 []。
StoreFront 登录
用法
标头
| 字段 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用事件的版本 | 1.0 |
| id | 指示使用事件的唯一标识符 | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | 指示 CAS 用于识别云使用事件的事件类型 | Login |
| st | 指示事件在 Broker 中生成时的时间戳 | 2011-08-12T20:17:46.384Z |
| prod | 标识使用事件的原始产品和部署 | OnPrem.StoreFront |
| prodVer | StoreFront 版本(内部) | 3.30.0.0 |
有效负载
| 字段 | 描述 | 示例 |
|---|---|---|
| user
|
启动的用户。该值已混淆
|
fullName: C648FE671A44B3F7 (始终混淆)
samName:C758LH671A44B3F7 (始终混淆) upn: C7948FE671A44B3F7 (始终混淆) userLicenseId:C265FE671A44B3F7 (始终混淆) userSid: C097FE671A44B3F7 (始终混淆) |
| serverName | 指示 StoreFront 运行所在服务的主机名 | storefront-01.storefront.local |
| loginMethodRfWeb | 指示用户从 RFWeb 登录 StoreFront 所使用的方法 | 0 |
| loginMethodAuth | 指示用户从身份验证服务登录 StoreFront 所使用的方法 | 0 |
| gatewayURL | 指示登录期间使用的 Netscaler Gateway | netscaler-gateway.com |
| enabledFeatures | 指示已启用功能的位掩码 | 12 |
| userAgent | 指示用于登录的客户端的 UserAgent | CitrixReceiver/22.11.0.19 Linux/5.17.15 X1Class CWACapable CWA/22.11.0.19 |
| baseUrl | 指示用户登录的商店 | storefront-dev.storefront.dev |
| storePath | 指示用户登录的商店 | /Citirx/StoreWeb |
| apiUsed | 指示客户端是否正在使用 Store 或 PNAgent API | 0 |
| deviceId | 指示用于登录 StoreFront 的设备。该值已混淆 | john-doe |
| transactionId | 指示在单个事务期间发送/生成的事务 ID | 773aba9e-5b91-4ef9-8782-c4afb75698e7 |
委派管理
用法
标头
| 键 | 描述 | 示例 |
|---|---|---|
| ver | 指示许可证使用事件的版本。 | 1 |
| id | 指示使用事件的唯一标识符。 | 8c2e20a5-ca3f-4401-ad69-d037933c40a0 |
| type | 指示 Citrix Analytics Service 用于识别云使用事件的事件类型。 | DelegatedAdmin.Usage |
| st | 指示在 Delegated Admin 中生成事件的时间戳。 | 2024-03-22T01:32:23.4056195Z |
| prod
|
标识使用事件的源产品和部署。
|
XenDesktop.DelegatedAdmin (Cloud) |
| OnPrem.DelegatedAdmin (OnPrem) | ||
| prodVer | 指示 Citrix DaaS 或 Citrix Virtual Apps and Desktops 产品版本。 | 7.42.0.0 |
负载
| 键 | 描述 | 示例 |
|---|---|---|
| TotalCustomScopes | 指示自定义作用域的总数。 | 2 |
| TotalCustomRoles | 指示自定义角色的总数。 | 4 |
混淆许可遥测数据
考虑到许可证遥测数据中信息的敏感性,Citrix 提供了一个混淆数据的选项。
下表列出了可混淆的数据:
| 字段 | 描述 | 示例 |
|---|---|---|
| user
|
标识用于唯一识别启动会话的用户 ID。
|
|
| dvc -> dvcName | 指示设备的友好名称。 | C758LH671A44B3F7 |
| workerSid | 指示用于会话的 VDA 的唯一标识符。 | 1E5LH671A44B3F7 |
| AdminLoginList | 指示唯一管理员的 SamAccountName 列表。 | {AdminLoginList: [UFMJ+JvXOTHO9mQDsOweiw= =]} |
| stores | 指示 StoreFront 存储配置 JSON blob。Store 对象的数组。某些值已混淆 | 示例 |
| deviceId | 指示用于登录 StoreFront 的设备。 | john-doe |
要在 Delivery Controller 上启用或禁用混淆,请运行以下 PowerShell 命令。
注意:
对于 Citrix Service Provider™ (CSP) 客户,混淆始终处于禁用状态。CSP 客户无法使用 PowerShell 命令启用混淆。
- 从 Delivery Controller 主机打开 PowerShell 窗口。
- 运行命令
asnp citrix以加载 Citrix 特定的 PowerShell 模块。 -
运行以下命令以启用或禁用混淆:
默认情况下,值为
1或true,这会启用许可证遥测数据的混淆。要禁用:
Set-BrokerServiceConfigurationData Core.ScrambleLicensingData -SettingValue $false <!--NeedCopy-->禁用混淆后,可以使用以下命令启用它:
Set-BrokerServiceConfigurationData Core.ScrambleLicensingData -SettingValue $true <!--NeedCopy-->
Citrix Virtual Apps and Desktops™ 遥测数据元素
已复制!
失败!