Session Recording

Check the recording success rate

June 21, 2024

Contributed by:

B C

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:

Use a domain user account with proper permission to log on to the machine where you have installed the Session Recording server.
Start PowerShell and change the current drive to the <Session Recording server installation path>\Bin folder.
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
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

50% recording success rate

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Check the recording success rate

June 21, 2024

Contributed by:

B C

June 21, 2024

Contributed by:

B C

Check the recording success rate

Prerequisites

Steps

In this article