Telemetry
StoreFront sends telemetry on your Storefront Configuration and log in events to Citrix Cloud. This is sent via either a local on-prem DDC and license server or via Cloud connectors to DaaS. For more information, see Citrix Virtual Apps and Desktops documentation.
StoreFront configuration
Usage
Headers
| Field | Description | Example |
|---|---|---|
| ver | Indicates the version of the license usage event | 1.0 |
| id | Indicates the unique identifier of the usage event | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | Indicates the event type used by CAS to identify cloud usage events | Configuration |
| st | Indicates the timestamp when the event is generated in StoreFront | 2011-08-12T20:17:46.384Z |
| prod | Identifies the originating product and deployment of the usage event | OnPrem.StoreFront |
| prodVer | Indicates the StoreFront version (internal) | 3.30.0.0 |
Payload
| Field | Description | Example |
|---|---|---|
| serverName | Indicates the hostname of the service StoreFront is running on | storefront-01.storefront.local |
| deploymentId | Indicates the unique identifier of the deployment of StoreFront | f47ac10b-58cc-4372-a567-0e02b2c3d479 |
| installedWithCVAD | Indicates whether the StoreFront was installed alongside CVAD | false |
| cpuCores | Indicates the total number of CPU cores | 4 |
| cpuModel | Indicates the CPU running StoreFront | 12th Gen Intel(R) Core(TM) i7-1255U 1.70 GHz |
| ramGb | Indicates the total amount of RAM in GB | 16 |
| numServersInGroup | Indicates the number of servers in the server group | 3 |
| stores | Indicates the StoreFront Store configuration JSON blob. An array of Store objects. Some values are scrambled | Example |
| rfWebSites | Indicates the StoreFront RFWeb configuration JSON blob. An array of RFWeb Config objects | Example |
| gateways | Indicates the gateway configuration objects as JSON blob. An array of gateway objects | Example |
| authServices | Indicates the Auth service configuration objects as JSON blob. An array of auth services objects | Example |
| IsPiiScrambled | true | |
Example of field 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-->
If no Stores are found, it is an empty array [].
Example of field 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-->
If no rfWebSites are found, it is an empty array [].
Example of field gateways
[{
"GatewayId": "gatewayId",
"IsCloudGateway": true,
"LoadBalancingSTAEnabled": true,
"SessionReliabilityEnabled": true,
"RequestTicketsFromTwoSTA": true,
"Version": "1234",
"LogonType": "domain",
"SmartCardFallbackEnabled": true
}]
<!--NeedCopy-->
If no gateways are found, it is an empty array [].
Example of field authServices
[{
"SiteId": "SiteId",
"Store": "StoreAuth",
"AuthMethodsEnabled": [
"ad"
],
"PasswordChangeWhenExpired": 0,
"PasswordRemindersForm": 1,
"DelegateCredentialValidationToCitrix": true,
"ValidatePasswordsOnDeliveryControllers": true
}]
<!--NeedCopy-->
If no auth services found, it is an empty array [].
Storefront Login
Usage
Headers
| Field | Description | Example |
|---|---|---|
| ver | Indicates the version of the license usage event | 1.0 |
| id | Indicates the unique identifier of the usage event | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | Indicates the event type used by CAS to identify cloud usage events | Login |
| st | Indicates the timestamp when the event is generated in Broker | 2011-08-12T20:17:46.384Z |
| prod | Identifies the originating product and deployment of the usage event | OnPrem.StoreFront |
| prodVer | StoreFront version (internal) | 3.30.0.0 |
Payload
| Field | Description | Example |
|---|---|---|
| user
|
The user that initiated the launch. The value is scrambled
|
fullName: C648FE671A44B3F7 (always scrambled)
samName:C758LH671A44B3F7 (always scrambled) upn: C7948FE671A44B3F7 (always scrambled) userLicenseId:C265FE671A44B3F7 (always scrambled) userSid: C097FE671A44B3F7 (always scrambled) |
| serverName | Indicates the hostname of the service StoreFront is running on | storefront-01.storefront.local |
| loginMethodRfWeb | Indicates the method the user used to login to StoreFront from RFWeb | 0 |
| loginMethodAuth | Indicates the method the user used to login to StoreFront from the Auth service | 0 |
| gatewayURL | Indicates the Netscaler Gateway used during login | netscaler-gateway.com |
| enabledFeatures | Indicates a bitmask of enabled features | 12 |
| userAgent | Indicates the UserAgent of the client used to login | CitrixReceiver/22.11.0.19 Linux/5.17.15 X1Class CWACapable CWA/22.11.0.19 |
| baseUrl | Indicates the store that the user login to | storefront-dev.storefront.dev |
| storePath | Indicates the store that the user login to | /Citirx/StoreWeb |
| apiUsed | Indicates if the client is using the Store or PNAgent API | 0 |
| deviceId | Indicates the device that is used to log into StoreFront. The values is scrambled | john-doe |
| transactionId | Indicates the transaction ID that is sent/generated during a single transaction | 773aba9e-5b91-4ef9-8782-c4afb75698e7 |
Telemetry
Copied!
Failed!