Logs

For troubleshooting, it may be helpful to download the log files from the PPL controller. This section explains different methods for downloading these log files. The available methods include using the NATS application, the SCP command in the terminal, or FileZilla. The first method is preferred as it is the easiest.

Via NATS Application (Preferred)

In the examples folder, there is an application called download-logs.py that retrieves log files from the PPL controller and stores them in a folder called logs on your local machine within the current directory. Follow the steps below:

1. Open Visual Studio Code

   Open Visual Studio Code.

2. Open repository

   Open the folder containing the dep-ppl-app repository.

3. Open a new terminal

   Open a new terminal by clicking on Terminal in the top menu bar and selecting New Terminal. A terminal window will open at the bottom of your screen.

4. Run the command

   Run the following command in the terminal:

   python download-logs.py
   

   The files will be stored in the logs folder on your local machine and current directory.

Via SCP Command

1. Open a Terminal

   On your local machine, open a terminal:

   • Windows: use Command Prompt, PowerShell, or a terminal emulator like Git Bash.
   • MacOS or Linux: open the default Terminal application.
   • Alternatively, you can use the terminal in VS Code.
2. Use the SCP Command

   To download a specific log file from the remote controller, use the scp command:

   scp admin@<ipAddress>:/opt/ppl/log/<filename> /local/path/
   

   • Replace ipAddress with the IP address of the controller.
   • Replace filename with the actual name of the log file you want to download
     • Filenames include: ppl.log, pplpy.log, livebit.log, natsdriver.log.
   • Replace /local/path/ with the directory path on your local machine where you want to save the log file.

   For example, if your controller is at IP 192.168.1.10, you want to download the pplpy.log file, and you want to save it to your Desktop, the command would look like this:

   scp admin@192.168.1.10:/opt/ppl/log/pplpy.log ~/Desktop/
   

3. Enter the Password

   After running the command, you’ll be prompted to enter the password for the admin user. Once you provide the correct password, the log file will be copied to your specified local directory.

Here are some useful tips for downloading log files using the SCP command:

Show Download Multiple Files

If you want to download all the log files in the /opt/ppl/log directory, you can use the following command:

scp admin@192.168.1.10:/opt/ppl/log/* /local/path/

This command will copy all files in the /opt/ppl/log directory to your local machine.

Show Download Files to Current Directory

If you want to download the log files to the current directory on your local machine, you can use the following command:

scp admin@192.168.1.10:/opt/ppl/log/ppl.log .

Via FileZilla

1. Download and Install FileZilla

   • Go to the Website: Open your browser and visit FileZilla official website.
   • Download FileZilla: Click on the Download FileZilla Client button and choose the appropriate version for your operating system (Windows, macOS, Linux).
   • Install: Run the downloaded file and follow the installation prompts.
2. Launch FileZilla

   • After installation, open FileZilla from your Start Menu or Applications folder.
3. Connect to the Controller

   • Open the FileZilla Interface: You’ll see fields at the top labeled Host, Username, Password, and Port.
   • Enter Connection Details:
     • Host: Enter the IP address of the controller (e.g., 192.168.1.10).
     • Username: Enter the username for your controller (admin).
     • Password: Enter the admin password for your controller.
     • Port: Enter 22 for SFTP (secure FTP).
   • Click Quickconnect: Connect to the controller.
4. Navigate to the Logs Directory

   • Remote Site: In the Remote site panel (right side), navigate to the /opt/ppl/log directory where the logs are stored.
   • Select Logs: Click on the /opt/ppl/log/ folder to open it and view the log files.
5. Download the Logs

   • Select Files: Click on the log files you want to download (you can select multiple files by holding the Ctrl (Windows) or Cmd (macOS) key).
   • Download Files: Right-click on the selected files and choose Download or drag them to the Local site panel.
   • Monitor Download: Check the download progress at the bottom of the FileZilla interface.
6. Disconnect from the Controller

   • Once the download is complete, you can disconnect by clicking on the Disconnect button (red “X” icon) in the toolbar or simply close the FileZilla application.

If you have questions about possible errors in the log files or would like the PPL Support team to review them, feel free to email your request to [e-mail], and be sure to include the log files.