Data Structure of the Sessions Events
Sessions Dimensions Data Source
Session Meta Data | Type | Nullable | Description | Values |
---|---|---|---|---|
sessionKey | GUID | No | Identifier for a virtual app or desktop session | |
userId | GUID | No | User AD identifier for a virtual app or desktop session | |
userName | String | No | Name of the user who has launched a virtual app or desktop session | |
deliveryGroupId | GUID | No | Delivery Group Identifier | |
deliveryGroupName | String | No | Delivery Group Name | |
siteId | GUID | No | Citrix Virtual Apps and Desktops Site Identifier | |
siteName | GUID | No | Citrix Virtual Apps and Desktops Site Name | |
machineId | GUID | No | Machine Identifier of the machine on which session is launched | |
machineSid | GUID | No | Machine AD Identifier of the machine on which session is launched | |
machineName | String | No | Name of the machine on which session is launched | |
sessionLaunchStatus | String | No | Launch status of the session | 0 (Successful Launch), 1(Session Failed), 2(User Terminated) |
sessionStartTime | timestamp | No | Time when the session was launched | |
protocol | String | Yes | Protocol used to launch the session | HDX, RDP, Console |
sessionType | String | No | Session Type | Desktop or Application |
sessionEndTime | timestamp | Yes | Time when session ended | |
stateChangedTime | timestamp | Yes | Time at which the session state changed | |
sessionState | String | No | Session life cycle state | Connected, Disconnected, Reconnected, Terminated |
sessionLaunchType | String | No | Session Launch type | ICA, ConnectionLease |
endpointOS | String | No | CWA app - OS Type | Android, HTML5,Mac,Macintosh → Mac,ThinOS → ChromeOS,Unix / Linux, Windows, Windows Mobile, Windows RT → Windows, iOS |
endpointReceiverVersion | String | No | CWA app Version | |
endpointLocationContinent | String | No | Continent from which the session was launched | |
endpointLocationCountry | String | No | Country from which the session was launched | |
endpointLocationCity | String | No | City from which the session was launched | |
endpointLocationLatitude | String | No | Latitude from which the session was launched | |
endpointLocationLongitude | String | No | Longitude from which the session was launched | |
endpointLocationTimezone | String | No | Timezone of the place where the session was launched | |
isp | String | No | ISP using which the session was launched | |
gatewayFQDN | String | Yes | Gateway FQDN through which the session was launched | |
vdaIP | String | Yes | IP of VDA on which the session was launched | |
connectionType | String | Yes | Type of connection established from the Citrix Workspace app | Internal,External |
connectionViaAG | String | No | ||
networkInterfaceType | String | No | Network Interface Type of the endpoint device | Wifi, Ethernet etc. |
failureReason | integer | No | Failure Category in which error has occurred | 0 - “None” |
1 - “Client Connection Failure” | ||||
2 - “Machine Failure” | ||||
3 - “No Capacity Available” | ||||
4 - “No Licenses Available” | ||||
5 - “Configuration” | ||||
6 - “Communication Failure” | ||||
failureCode | integer | No | Specifies type of failure | 0 - “Unknown error” |
1 - “No failure” | ||||
2 - “Session preparation failed” | ||||
3 - “Registration timeout” | ||||
4 - “Connection timeout” | ||||
5 - “License unavailable” | ||||
6 - “Ticketing failed” | ||||
7 - “Unknown failure” | ||||
8 - “General failure” | ||||
9 - “Resource in maintenance mode” | ||||
10 - “Application disabled” | ||||
11 - “Required feature not licensed” | ||||
12 - “VDA unavailable” | ||||
13 - “VDA is already in use” | ||||
14 - “Requested protocol not allowed” | ||||
15 - “Resource unavailable” | ||||
16 - “Active session reconnect disabled” | ||||
17 - “Cannot find session to reconnect” | ||||
18 - “VDA power up failed” | ||||
19 - “Session refused” | ||||
20 - “Set configuration failed” | ||||
21 - “Total concurrent usage limit of app reached” | ||||
22 - “Per user usage limit of app reached” | ||||
23 - “VDA not contactable” | ||||
24 - “Per machine usage limit reached” | ||||
25 - “Per entitlement usage limit leached” | ||||
51 - “Endpoint to Machine Communication error” | ||||
52 - “Gateway to Machine Communication error” | ||||
100 - “VDA unavailable” | ||||
101 - “VDA not functional” | ||||
failureReasonString | String | Yes | FailureReasonString mapped to string value of failureReason | |
failureCodeString | String | Yes | FailureCodeString mapped to string value of failureCode | |
sessionScore | integer | No | Session Experience score based on the performance factors | -1 - 100 |
userScore | integer | No | User experience score calculated based on session experience and failure rate | 0 -100 |
icaRtt | integer | No | Session Responsiveness which defines average round trip time of ICA session in the last 15 minutes interval | >= 0 |
icaRttScore | integer | No | IcaRtt (Session Responsiveness) score is calculated based on current IcaRtt value and deviation from the baseline threshold of that metric | 0 - 100 |
reconnects | integer | No | Number of auto-reconnects that happened in the last 15 minutes interval | >= 0 |
reconnectScore | integer | No | reconnectScore(Session Resiliency) score is calculated based on current number of auto-reconnects and deviation from the baseline threshold of that metric | 0 - 100 |
logonDuration | integer | No | Total log on duration for this session (total initialization time of the session) | >= 0 |
brokeringDuration | integer | Yes | Total time taken by Broker in initializing the session | >= 0 |
vmStartDuration | integer | Yes | Total time taken in starting the VM during the logon process | >= 0 |
hdxConnectionDuration | integer | Yes | Total time taken by HDX connection during the logon process | >= 0 |
authenticationDuration | integer | Yes | total time taken in authentication during the logon process | >= 0 |
gpoDuration | integer | Yes | Total time taken in GPO processing during the logon process | >= 0 |
logonScriptsDuration | integer | Yes | Total time taken in logon script processing during the logon process | >= 0 |
profileLoadDuration | integer | Yes | Total time taken in profile load during the logon process | >= 0 |
interactiveSessionsDuration | integer | Yes | Total time taken in initializing interactive session including shell initialization time | >= 0 |
logonDurationScore | integer | No | logonDuration score is calculated based on current logonDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
gpoScore | integer | No | GPO score is calculated based on current GPO value and deviation from the baseline threshold of that metric | 0 - 100 |
profileLoadScore | integer | No | profileLoad score is calculated based on current profileLoadDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
interactiveSessionScore | integer | No | interactiveSession score is calculated based on current interactiveSessionDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
brokeringScore | integer | No | brokering score is calculated based on current brokeringDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
vmStartScore | integer | No | vmStart score is calculated based on current vmStartDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
hdxConnectionScore | integer | No | hdxConnection score is calculated based on current hdxConnectionDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
authenticationScore | integer | No | authentication score is calculated based on current authenticationDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
logonScriptsScore | integer | No | logonScripts score is calculated based on current logonScriptsDuration value and deviation from the baseline threshold of that metric | 0 - 100 |
profileSize | integer | Yes | Total profile size of a user | > 0 |
totalFileCount | integer | Yes | Total files in that profile | > 0 |
largeFileCount | integer | Yes | Total number of large files in that profile | > 0 |
failureScore | integer | No | Calculated based on number of failures against number of session launches in the last 15 minutes interval | 0 - 100 |
failureCount | integer | No | Total failures that occurred in the last 15 minutes interval | >= 0 |
launchAttempts | integer | No | Total launches attempted in the last 15 minutes interval | >=0 |
machineFailureCount | integer | No | Total count of machine failures | >=0 |
clientConnectionFailureCount | integer | No | Total count of client connection failures | >=0 |
capacityFailureCount | integer | No | Total count of capacity failures | >=0 |
configurationFailureCount | integer | No | Total count of configuration failures | No |
licenseFailureCount | integer | No | Total count of license failures | >=0 |
communicationFailureCount | integer | No | Total count of communication failures | >=0 |
inputBandwidthAvailable | integer | Yes | Average Input Bandwidth Consumed by ICA Session in last 15 minute | >=0 |
inputBandwidthConsumed | integer | Yes | Average Input Bandwidth Consumed by ICA Session in last 15 minute | >=0 |
outputBandwidthAvailable | integer | Yes | Average Output Bandwidth Available in last 15 minute | >=0 |
outputBandwidthUsed | integer | Yes | Average Output Bandwidth Used in last 15 minute | >=0 |
networkLatency | integer | Yes | Average Network latency of the ICA Session in last 15 minute | >=0 |
endpointLinkSpeed | integer | Yes | Link speed of the endpoint device network interface like wifi, ethernet | >=0 |
endpointSignalStrength | integer | Yes | Signal Strength of the endpoint device | >=0 |
avgEndpointThroughputBytesReceived | integer | Yes | Total bytes received on network interface | >=0 |
avgEndpointThroughputBytesSent | integer | Yes | Total bytes sent on network interface | >=0 |
wanLatency | integer | Yes | This subfactor is the latency measured from the virtual machine to the Gateway. A high WAN Latency indicates sluggishness in the endpoint machine network. WAN latency increases when the user is geographically farther from the Gateway. | >=0 |
dcLatency | integer | Yes | This subfactor is the latency measured from the Citrix Gateway to the server (VDA). A high Data Center Latency indicates delays due to a slow server network.This metrics is available only when on-premises gateway is onboarded to CAS | >=0 |
hostDelay | integer | Yes | This subfactor measures the Server OS induced delay. A high ICA RTT with low Data Center and WAN latencies, and a high Host Latency indicates an application error on the host server. | >=0 |
wanLatencyScore | integer | No | WAN Latency Score is calculated based on wanLatency value and deviation from baseline threshold value of the same metric | 0 - 100 |
dcLatencyScore | integer | No | DC Latency Score is calculated based on dcLatency value and deviation from baseline threshold value of the same metric | 0 - 100 |
hostDelayScore | integer | No | Host Delay Score is calculated based on host delay value and deviation from baseline threshold value of the same metric | 0 - 100 |
Data Structure of the Sessions Events
Copied!
Failed!