Collect diagnostic data from edge nodes with collect-info.sh

Updated March 04, 2025 18:06

Introduction

The Collect Info Script (collect-info.sh) is used to collect all info from an edge node, which helps to debug and resolve EVE-OS issues.

Prerequisites

You need at least EVE-OS 11 to use the script that’s built into the OS.
If you don't have at least EVE-OS 11, you need to download the Collect Info Script and manually upload it to your edge device.
- If you download the script, you need to give execute permission to the script.
- ```
chmod +x collect-info.sh
```
You need access to the edge device (for example: physical, remote console, SSH, or Edge View).

Use collect-info.sh

This example uses SSH. But if the host computer is not on or accessible by the requesting computer, then you can use Edge View, physical access, or remote console.

1. Access your edge device. For example, SSH into your edge device.
```
ssh -i ~/.ssh/id_rsa root@EDGE_DEVICE_IP_ADDRESS
```
2. Type collect-info.sh in collect-logs mode or read-logs mode using any options of your choice.
  If you use the script from EVE-OS with no options, the script collects all the logs and states, and makes a tarball. See the following options: Type collect-info.sh in collect-logs mode or read-logs mode using any options of your choice:
  
  collect-logs mode
  If you use the script in collect-logs mode, the script collects all the logs, states, and makes a tarball.
```
collect-info.sh [-s]
     -s                   	tar whole /sysfs
```
  read-logs mode
  If you use the script in read-logs mode with options, the script collects items of your choice. See the following options:
```
collect-info.sh [-v] [-h] [-a APPLICATION-UUID] [-d]
     -d                   	read device logs only      
     -a APPLICATION-UUID  	read specified application logs only
     -t NUMBER-OF-DAYS    	read logs from the last NUMBER-OF-DAYS [1-30]
     -e                   	additional edgeview string in filename
     -j                   	output logs in json
     -h   			show this help
     -v   			show the script version
```
3. Depending on the version of the script, the output file is generated in the /persist/ directory or in the /persist/eve-info/ directory after a few minutes. The following examples show /persist/eve-info/.
```
/persist/eve-info/eve-info-FILE_NAME.tar.gz
```
4. Copy this file to your local system, using SCP for example.
```
scp /persist/eve-info/eve-info-FILE_NAME.tar.gz YOUR_USER_NAME@DESTINATION_IP_ADDRESS:/REMOTE/PATH/eve-info-FILE_NAME.tar.gz
```
  Example: Download from a PC client
  Example of downloading from an edge node using a client, such as your PC. Use the -O flag (uppercase O, not zero), otherwise the transfer fails. Recent ssh clients default to using SFTP, which is not enabled in EVE-OS. So the -O flag ensures that the client uses SCP for the download.
  scp -O root@my-node:/persist/eve-info/eve-info-v31-2025-01-21-13-47-50.tar.gz . Warning: Permanently added '10.168.122.108' (ED25519) to the list of known hosts. eve-info-v31-2025-01-21-13-47-50.tar.gz
5. Delete the file from your edge device after you’ve copied it to your local system.
```
rm /persist/eve-info/eve-info-FILE_NAME.tar.gz
```

Use Edge View to run collect-info.sh

Configure Edge View.

Run the following command.

./<SCRIPT_NAME> collectinfo

Example

Call the script and send collectinfo as the parameter.

./run.TGM-JX98247BVK-MQNJD_DFI.4726183947.edgeview.sh collectinfo

The logs will be downloaded to the local machine in the /tmp/download folder.

Next Steps

You can submit a support request and link to the file from your preferred shared drive.

Was this article helpful?

0 out of 0 found this helpful