Collect and sanitize Digital Lab logs

You can collect and sanitize Digital Lab server and connector logs. This section is relevant only for UFT Digital Lab.

Overview

You can run a script in the command line, to collect and sanitize Digital Lab server and connector logs. You can limit the size of logs, by selecting logs for a specific machine, or by selecting the latest logs only. This is useful because the log files may contain a large number of files. If you are only interested in a particular machine or time period, downloading specific logs makes it easier to identify the information that you are looking for. With the script, you can also mask sensitive information such as machine addresses or user names, and prevent this data from being included in the logs.

Back to top

Run the script

Run the script in the Digital Lab server's bin folder. The parameters -output and -adminExecutionToken are required:

Windows <Digital Lab_server_installdir>\server\bin\log_sanitization.bat -output <destination folder> -adminExecutionToken <execution key string>


Default path to file: C:\Program Files\UFT Digital Lab Server\server\bin\log_sanitization.bat
Linux <Digital Lab_server_installdir>/server/bin/log_sanitization.sh -output <destination folder> -adminExecutionToken<execution key string>


Default path to file: /opt/UFTDigitalLab/server/bin/log_sanitization.sh

The following table includes script parameters:

Parameter Options
-collectServer
  • yes (default)
  • no
-collectConnectors
  • all (default)
  • specific

    When this parameter is used, you also need to provide the name of the connector. This is the name displayed in the Device lab > Connectors tab.

-collectPeriod
  • all (default)
  • latest
-dataToMask
  • all (default)
  • usernames
  • app_details

    masks the app names and bundle IDs

  • machine_addresses
  • directories

    file system paths: base install directory, base storage directory, base temp directory.
-output The directory to which save the logs.
-adminExecutionToken Execution access key of the Digital Lab admin user. For details on access keys, see Access key management.

Example:

This is an example of running the script to collect the latest server and connector logs, masking all the data.

C:\Program Files\UFT Digital Lab Server\server\bin\log_sanitization.bat -output C:\MyLogs -adminExecutionToken "client=oauth2-*******@opentext.com; secret=***********; tenant=*******" -collectPeriod latest -dataToMask all