This topic will guide you on how to troubleshoot CloudShell execution errors. CloudShell saves details of execution activity in different logs, according to automation piece and execution server type (Windows or Linux).
If you are a user or an Admin, you can use these logs to troubleshoot your issue. In some cases, if you have approached Quali Customer Support for assistance, they may ask for these logs to analyze the circumstances that led up to the error.
CloudShell logs include the following:
- QualiX logs
- Linux execution server logs
- Windows execution server logs
- L1 shell execution logs
We also recommend that you use the system messages displayed in CloudShell Portal, for example, the Activity Details Window, which presents detailed information pertaining to a specific error or message in the activity feed, including the event's logging information and (for command execution errors) the execution server on which the command is supposed to run. For more information on all CloudShell system messages, see the CloudShell help topic Viewing System Messages.
CloudShell Monitor is a tool that collects CloudShell logs and data from the machine it is running on. It delivers a snapshot of the situation immediately prior to when the logs were extracted.
We suggest that you watch this short video demonstrating how to collect and save system log files using CloudShell Monitor:
To collect the system logs, perform the following steps:
You will need the logs from the Quali Server machine and the relevant client machine (Studio, Execution Server, CloudShell Portal, etc.).
- On the appropriate machine, open CloudShell Monitor.
Click Save Logs and from the drop-down list, select Save Logs and Windows Event.
A zip file containing the log files is downloaded to your computer.
Save the zip file.
Open a support ticket at https://support.quali.com/ and attach the zip file to your ticket.
If the zip file is too large to attach to your support ticket (greater than 20 MB), you will receive a Payload is Too Large message in the top right corner of your screen. If this is the case, do the following:
- Log on to the QualiSystems FTP site.
If you do not have the required credentials, contact customer support.
- Save the zip file on QualiSystems FTP.
The file is saved in your account's FTP folder.
- In the ticket, state that you uploaded the log files to QualiSystems FTP.
A Quali support representative will review the logs and contact you.
The zip file contains the following files, depending on the CloudShell component:
Log name Type EventLogs File folder RemoteTeamServer File folder SetupLogs File folder Monitor File folder CloudShell Authoring File folder CloudShell Configuration File folder CloudShell License Server File folder CloudShell Remote Runner File folder CloudShell Resource Management Client File folder CloudShell Runtime File folder CloudShell Sandbox API File folder CloudShell Sandbox API Gateway File folder CloudShell Server Proxy File folder Quali Server File folder TestShell Execution Server File folder TestShell QSMQ Server File folder TestShell Studio File folder RunningProcesses.txt Text Document SytemInfo.exe.txt Text Document SystemInformation.txt Text Document QualisystemsRegistry.txt Text Document InstallInfo.txt Text Document
- Log on to the QualiSystems FTP site.
To collect QualiX logs, perform the following steps:
- Download the QualiX.rar PowerShell script from Quali's Download Center. The utility is in the QualiX section: "For versions 8.3 Patch 1 and above (TLS 1.2 support)" within Utilities.
- Extract the files to your local directory.
- Edit the
.\ GetQualiXInfo.ps1file and set the Username and Password to the QualiX machine.
Save the file and run the
.\ GetQualiXInfo.ps1file with Windows PowerShell.
The script connects to QualiX using SSH and extracts the logs from the QualiX machine.
When prompted, enter the IP address of the QualiX machine.
The command returns the QualiX logs.
- Transfer the files from the Linux machine to your local machine and open it in notepad++.
- Open a support ticket and attach the files to your ticket.
Note: If you are using a Windows machine to extract logs from the Linux execution server, we recommend using an SCP client, like WinSCP, to connect via SSH to the Linux execution server to browse though the logs. You can also transfer the files to a Windows machine in order to send them, if needed.
To extract logs if you are using Linux execution server on a Virtual Appliance (VA):
- General execution server logs: ~/ExecutionServer/Logs
- Shell execution logs: /var/log/qualiSystems/
- Orchestration script execution logs: ./usr/share/QualiSystems/logs
To extract logs if you are using Linux ES on CloudFormation (AWS) or CloudShell Template (Azure):
When a Windows-based execution server runs a python command, either shell-based or an orchestration script, the execution server's logs will be saved here: C:\ProgramData\QualiSystems\logs.
Shell execution logs (resource discovery and inventory commands): C:\ProgramData\QualiSystems\logs\inventory
Note that older logging packages are sometimes logged to C:\ProgramData\QualiSystems\logs\Autoload
- Latest shell/cloud provider execution logs: C:\ProgramData\QualiSystems\logs\<reservation-id>\<driver name>
- Latest orchestration script logs: C:\ProgramData\QualiSystems\logs\<reservationid>
Look here for the L1 shell execution logs on the Quali Server machine:
~QualiSystems\CloudShell\Server\Logs\<L1 shell name>.