Product documentation
Session Recording
Service Current Release 2311 2308 2305 2303 2212 2210 2209 2207 2206 2204 2203 LTSR 2201 1912 LTSR 7.15
View PDF

Check the recording success rate

April 25, 2024
Contributed by: 
B

You can check the recording success rate to learn whether all sessions that match the active recording policy are recorded. The recording success rate is calculated as follows:

Recording success rate = the number of successfully recorded sessions / the total number of sessions matching the active recording policy

Prerequisites

  • This feature requires the Session Recording server minimum version 2203.

  • To obtain site configuration and session data for accurate calculation, you must install the Broker PowerShell Snap-in (Broker_PowerShellSnapIn_x64.msi). You can locate the snap-in on the Citrix Virtual Apps and Desktops ISO (\x64\Citrix Desktop Delivery Controller) and follow the instructions to install it.

  • For an on-premises Delivery Controller, install and use the Citrix Virtual Apps and Desktops PowerShell SDK. For a Delivery Controller in Citrix Cloud, install and use the Citrix DaaS Remote PowerShell SDK. To determine which SDK to install and use, be aware of the Delivery Controller that you specified when you configured your recording policy.

Steps

To check the recording success rate across your deployment, complete the following steps:

  1. Use a domain user account with proper permission to log on to the machine where you have installed the Session Recording server.

  2. Start PowerShell and change the current drive to the <Session Recording server installation path>\Bin folder.

  3. Run a command based on the type of your deployment:

    • For an on-premises Delivery Controller, run either of the following commands as needed:

      • If the FQDN of the Session Recording server is the same with the FQDN in the certificate bound to the Session Recording server, run SsRecUtils.exe -CalcRecSuccessRate <Delivery Controller address>.

      • If you have specified a custom domain name with the certificate binding, run SsRecUtils.exe -CalcRecSuccessRate <Delivery Controller address> - SRBrokerURL <custom domain name>.

    • For a Delivery Controller in Citrix Cloud, run the following commands in sequence:

      • Add-PSSnapin Citrix.Broker.Admin.V2

      • Set-XDCredentials -CustomerId “<Citrix Cloud customer ID>” -SecureClientFile “<path to secure client file>” -ProfileType CloudApi -StoreAs default

      • get-xdauthentication

      • SsRecUtils.exe -CalcRecSuccessRate CloudDDC

  4. Check the recording success rate. If all sessions that match the currently active recording policy are recorded, the recording success rate is 100%. Otherwise, the recording success rate is lower than 100% and you are prompted to check failed recordings in a file where session details are provided. For example:

    100% recording success rate 100% recording success rate

    50% recording success rate 50% recording success rate

Check the recording success rate
April 25, 2024
Contributed by: 
B
April 25, 2024
Contributed by: 
B

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.