Skip to main content
Version: 1.1.0

Getting Logs from Virtual Appliance

Introduction​

Logging is a crucial aspect of maintaining and troubleshooting a Speech platform. This documentation article outlines two methods for retrieving log files from our platform - one using the graphical user interface (GUI) provided by the File Browser app and the other via a command-line interface using SSH.

Method 1: Using File Browser GUI​

  1. Access the File Browser:
    • Open the Web Browser and navigate to http://<IP_ADDRESS_OR_HOSTNAME>/filebrowser/files.
  2. Select log Folder:
    • In the File Browser, highlight the log folder by single click.
  3. 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.
  4. Save the Logs:
    • Select the zip or tar.gz format.
    • Choose a location on your local machine to save the downloaded log files.

Method 2: Using SSH Command-Line Interface​

If, for any reason, the File Browser is not available, you can use the command-line interface with SSH to retrieve the logs.

  1. Create a ZIP of Logs:
    • Open a terminal or command prompt on your local machine.
    • Use the following command to connect to the Linux virtual machine via SSH and create a compressed backup of the logs: 
      ssh root@<IP_ADDRESS_OR_HOSTNAME> "cd /data && tar -czvf logs_backup.tar.gz log"
    • Enter the required credentials when prompted.
    • This command connects to the machine and creates a compressed file named logs_backup.tar.gz containing the log folder.
  2. Transfer Files to Local Machine:
    • After creating the backup, use the following command to transfer the compressed file to your local machine using SCP: 
      scp root@<IP_ADDRESS_OR_HOSTNAME>:/data/logs_backup.tar.gz "c:\logs_backup"
    • Replace "c:\logs_backup" with the desired local directory where you want to save the log files backup.
  3. Verify Transfer:
    • Check the specified local directory to ensure that the logs_backup.tar.gz file has been successfully transferred.

Conclusion​

By following either the GUI-based approach through the File Browser or the command-line approach via SSH, you can efficiently retrieve log files from our platform. Choose the method that best fits your requirements or based on the availability of the File Browser.