Using enhanced logging projects

Enhanced logging for the Velocity Client is a way for administrators to turn on debug logging on Android devices and retrieve log files easily. Use enhanced logging for the Velocity log, the network log, or screen capture files. When you use enhanced logging to change the log level, the log levels set in any profile on the device is temporarily overridden. This allows you to start and stop debug logging without modifying existing host profiles or distributing files to the device.

Create an enhanced logging project, specify the log files or screen captures you want to gather, and then use the Client to scan the provided QR code. The Client turns on debug logging and/or screen capture until one of the following conditions is met: 

•The device user turns enhanced logging off.

•The Client is closed by tapping Menu > Exit.

•The device runs out of memory for the files.

When enhanced logging stops, the Client displays a message to the user, zips the files, and sends them to the Console where the administrator can look at them. If the Console is not available, the zip file is saved to the Downloads/com.wavelink.velocity directory on the device.

Enhanced logging can be turned on by the device user without a QR code, but the files are always stored locally on the device and not sent to the Console. For information on turning on enhanced logging without a QR code, see Using the Velocity Client. When you turn on enhanced logging without a QR code, it does not include screen capture files.

If you turn on screen capture for an enhanced logging project, the Client creates a separate screen capture file (.wltsc) for each session that is active while enhanced logging is being used.

If the device is Android 10, the Client does not have access to the Downloads/com.wavelink.velocity directory, so it saves the file in the Android/data/com.wavelink.velocity/files directory instead. Android devices that are versions newer or later than Android 10 allow access to the Downloads directory, but Android 10 does not.

How does the QR code work?

When you use a QR code to turn on enhanced logging, the Console acts like a server to receive files over HTTPS while the Console is showing the QR code. The traffic is secured using a token included in the QR code. For proper security, you should only show the QR code when you are actively using enhanced logging. If you choose to print the QR code, we recommend you restrict access to it. The QR code is specific to the Console that generates it.

For the Console to receive the zip file from the Client, it must be showing the QR code when the device stops logging. Received files are saved in the Downloads folder. If the QR code is not showing, the Console will not accept any files. (In this case, the device shows a message that the Console is not available and stores the files locally.) However, if you close the project and then open it again later, the device can still send the files to the Console as long as the same QR code is showing when the Client stops logging. The QR code is no longer valid if you restart the Console or change the host address or port.

Enhanced logging options

An enhanced logging project has the following options: 

•Customer. A name for the company or organization that the project is associated with.

•Host. The IP address or hostname of the local computer. Since the host address is used in the QR code, if you change the host address, it changes the QR code as well and invalidates previously generated QR codes.

•Port. The port that the Console listens on for incoming files. Ensure nothing else is using this port.

•Include:

•Debug logging. Sets the log level for all sessions to debug and includes the Velocity log in the files sent to the Console.

•Network logging (TE only). Sets the log level for network logging to debug and includes the network log in the files sent to the Console. The network log does not apply to web sessions.

•Screen capture (TE only). Turns on screen capture and captures screens for all TE sessions that are active. Each session has a separate screen capture file. The screen capture files are sent to the Console. For more information on using screen captures to customize screens, see Configuring screens.

•Open log file location. Opens the local location where files that have been sent from devices are stored.

1.Launch the Velocity Console application.

2.Click the Create button in the top-right corner of the screen and select Enhanced logging.

3.Type a Name for the project. You can also provide a Company, which is used for sorting projects.

4.Click Create.

The project opens and you can configure the settings.

Perform the first two steps from the Velocity Console, and the rest of the steps with the Velocity Client on an Android device. You can start enhanced logging on the device without a QR code, but the device will not send the files to the Console when logging is completed.

1.In the Velocity Console, open an enhanced logging project.

2.In the top right corner, click Show barcode.

3.In the Velocity Client on an Android device, navigate to the profile list and tap Menu > Enhanced logging.

4.Provide the password, if required.

5.Scan the QR code with the device.

6.Tap Start enhanced logging.

The Client turns on the type of logging requested until one of the following conditions is met: the device user turns enhanced logging off by tapping Menu > Enhanced logging > Stop enhanced logging, the user taps Menu > Exit, or the device runs out of memory for the files. Make sure the enhanced logging QR code is shown when the device attempts to send the files, and when the zipped files are received by the Console, they appear in the Received files list.

If the Console is not available, the Client displays a message that it cannot contact the Console and stores the log files locally.

If the Client doesn't connect successfully, try using a different hostname for the Console. For example, if it failed to connect with the short hostname, try using the IP address instead.

•If you started enhanced logging using a QR code and the files were transferred to the Console, navigate to the Downloads\VelocityLogs directory on the Windows device where the Console is installed, and then each enhanced logging project has its own directory inside the VelocityLogs directory. If you have an enhanced logging project open, click the Open log file location button to open the folder specific for the current enhanced logging project. Unzip the file and then either use a text editor to open the log files, or import the .wltsc to a host profile.

-Or-

•If you started enhanced logging from the Client, or if the logs were not transferred to the Console, navigate to the Downloads/com.wavelink.velocity directory on the device. (Or, if the device is Android 10, navigate to the Android/data/com.wavelink.velocity/files directory.) Unzip the file and then either use a text editor to open the log files, or import the .wltsc to a host profile.