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 | The version of the license usage event | 1.0 |
| id | The unique identifier of the usage event | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | The event type used by CAS to identify cloud usage events | Configuration |
| st | The timestamp when the event is generated in Broker | 2011-08-12T20:17:46.384Z |
| prod | The originating product and deployment of the usage event | OnPrem.StoreFront |
| prodVer | The StoreFront version | 3.30.0.0 |
Payload
| Field | Description | Example |
|---|---|---|
| ver | The version of the payload | 1.2 |
| serverName | The hostname of the service StoreFront is running on | storefront-01.storefront.local |
| deploymentId | The unique identifier of the deployment of StoreFront | f47ac10b-58cc-4372-a567-0e02b2c3d479 |
| installedWithCVAD | Indicates whether StoreFront was installed alongside CVAD | false |
| cpuCores | The total number of CPU cores | 4 |
| cpuModel | The CPU running StoreFront | 12th Gen Intel(R) Core(TM) i7-1255U 1.70 GHz |
| ramGb | The total amount of RAM in GB | 16 |
| numServersInGroup | The number of servers in the server group | 3 |
| stores | The StoreFront Store configuration JSON blob. An array of Store objects. Some values are scrambled | Example |
| rfWebSites | The StoreFront website configuration JSON blob. An array of RFWeb Config objects | Example |
| gateways | The gateway configuration objects as JSON blob. An array of gateway objects | Example |
| authServices | The Auth service configuration objects as JSON blob. An array of auth services objects | Example |
| IsPiiScrambled | Is the PII in the payload scrambled? | true |
| baseURLs | An array of the list of base URLs used by this server | [“https://storefront.acme.com”, “https://storefront.acme2.com”] |
| serversInGroup | The list of StoreFront servers in the server group | [“storefront-a.acme.com”, “storefront-b.acme.com”, “storefront-c.acme.com”] |
| osName | The name of the OS | Windows Server 2025 |
| osVersion | The version number of the OS | 26100.7178 |
| wasUpgraded | Was the server upgraded from a previous version | true |
Example of field stores
[{
"SiteId": 1,
"BaseURL": "https://storefront.example.com/",
"VirtualPath": "/Citrix/Store",
"EnabledFeatures": 21 bit bitmap,
"DefaultRfWebSite": "/Citrix/StoreWeb",
"GatewaysUsed": [
"gatewayId"
],
"VdaLogonDataProvider": "",
"ResourceFeeds": [
{
"FeedName": "CVAD-US",
"Type": 1,
"LoadBalancingEnabled": true,
"Servers": ["ddc-1.acme.com", "ddc-2.acme.com"],
"TransportType": "https",
"AutoDiscoverServers": false,
"UseKeys": false
}
]
}]
<!--NeedCopy-->
If no Stores are found, it is an empty array [].
Example of field rfWebSites
[{
"SiteId": 1,
"BaseURL": "https://storefront.example.com/",
"VirtualPath": "/Citrix/StoreWeb",
"StorePath": "/Citrix/Store",
"UiExperience": 0,
"EnabledFeatures": 9 bit,
"AuthMethodsEnabled": [
"ExplicitForms"
],
"LogoffAction": 0,
"MultiClickTimeout": 3,
"DefaultTab": 0
}]
<!--NeedCopy-->
If no rfWebSites are found, it is an empty array [].
Example of field gateways
[{
"GatewayId": "0bb792c4-37b4-4fbe-a9a6-5ed71baaa603",
"GatewayURL": "https://sfgw.acme.com",
"IsCloudGateway": false,
"StasUseLoadBalancing": true,
"SessionReliability": true,
"RequestTicketTwoStas": true,
"SmartCardFallback": false,
"Version": 1234,
"Logon": "domain",
"StaServers": [
{"url": "sta1.example.com", "useKeys": true},
{"url": "sta2.example.com", "useKeys": true}
]
}]
<!--NeedCopy-->
If no gateways are found, it is an empty array [].
Example of field authServices
[{
"SiteId": 1,
"BaseURL": "https://storefront.example.com/",
"VirtualPath": "/Citrix/Authentication",
"AuthMethodsEnabled": [
"CitrixFederation",
"ExplicitForms"
],
"AllowUserPasswordChange": 2,
"ShowPasswordExpiryWarning": 1,
"ValidatePasswordsOnDeliveryControllers": false,
"DelegateCredentialValidationToGateway": false,
"IsAuthenticationServiceShared": false,
"EnabledFeatures": 1,
"isThirdPartyAuthSdkInUse": false
}]
<!--NeedCopy-->
If no auth services found, it is an empty array [].
Storefront Login
Usage
Headers
| Field | Description | Example |
|---|---|---|
| ver | The version of the license usage event | 1.0 |
| id | The unique identifier of the usage event | d4ce7919-5d80-44de-a8fa-102923fe0ead |
| type | The event type used by CAS to identify cloud usage events | Login |
| st | The timestamp when the event is generated in Broker | 2011-08-12T20:17:46.384Z |
| prod | The originating product and deployment of the usage event | OnPrem.StoreFront |
| prodVer | The StoreFront version | 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 | The hostname of the service StoreFront is running on | storefront-01.storefront.local |
| loginMethodRfWeb | Not used | |
| loginMethodAuth | The method the user used to login to StoreFront | 0 |
| gatewayURL | The URL of the Netscaler Gateway used during login | netscaler-gateway.com |
| enabledFeatures | A bitmask of enabled features | 12 |
| userAgent | 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 | The base url of the store that the user logged in to | storefront-dev.storefront.dev |
| storePath | The store path that the user logged in to | /Citrix/StoreWeb |
| apiUsed | Indicates if the client is using the Store API, Web API, or PNAgent API | 0 |
| deviceId | The name of the device used to log into StoreFront. The values is scrambled | john-doe |
| transactionId | Identifier used to group related events | 773aba9e-5b91-4ef9-8782-c4afb75698e7 |
Telemetry
Copied!
Failed!