Getting Diagnostics Data from Virtual Appliance
Introduction
Gathering Diagnostics Data is a crucial aspect of maintaining and troubleshooting Speech Platform 4. This documentation outlines a method for retrieving diagnostics data files from our platform - via a command-line interface through SSH using Diagnostics script.
The script itself is a part of Speech Platform 4 Virtual Appliance. The script is designed to gather system information and application information for troubleshooting.
The script collects following information:
- CPU, RAM and disk usage.
- System logs, application logs and event history.
- Information about kubernetes objects.
Create the diagnostics report
- Connect to the virtual appliance :
$ ssh root@<virtual-appliance-ip>
- Run diagnostics script:
$ /root/run-diag-report.sh
- Script gathers all the information and store them in the zip archive. This
file is stored in the
/data/reports
directory.
Now, when the diagnostics .zip is created, there are two ways of obtaining it - through command-line or through File Browser:
Download method 1: Command-line
- Transfer Files to Local Machine:
- After creating the diagnostics .zip file, use the following command to
transfer the compressed file to your local machine using SCP:
scp root@<IP_ADDRESS_OR_HOSTNAME>:/data/reports/va-report-YYYY-MM-DD_HH_MM_SS.zip "c:\diagnostics_data"
- Replace
YYYY-MM-DD_HH_MM_SS
with actual date and time information from the created .zip file and"c:\diagnostics_data"
with the desired local directory where you want to save the log files backup.
- After creating the diagnostics .zip file, use the following command to
transfer the compressed file to your local machine using SCP:
- Verify Transfer:
- Check the specified local directory to ensure that the
va-report-YYYY-MM-DD_HH_MM_SS.zip
file has been successfully transferred.
- Check the specified local directory to ensure that the
Download method 2: File Browser
- Access the File Browser:
- Open the Web Browser and navigate to
http://<IP_ADDRESS_OR_HOSTNAME>/filebrowser/files
.
- Open the Web Browser and navigate to
- Select log Folder:
- In the File Browser, go to
reports
folder and highlight the report .zip file generated in Create the diagnostics report guide.
- In the File Browser, go to
- Download Logs:
- Initiate the download process by clicking the highlighted 'down pointing arrow' button in the upper part of the screen.
- A dialogue window will pop up.
- Save the Logs:
- Choose a location on your local machine to save the downloaded log files.
Conclusion
By following the guide to generate diagnostics data and then saving the .zip file through either command-line or File Browser, you can efficiently retrieve diagnostics data from our platform. Choose the method that best fits your requirements or based on the availability of the File Browser.