Gather System Information Using the sosreport Tool¶

The sosreport tool enables you to gather information for support purposes by generating a report from a host. It is installed automatically on all servers, and embeds some custom plugins. It is run on demand and does not impact the system performance.

The output archive generated by the sosreport tool offers information on logs, configurations, containers, and other relevant data that can be sent to Scality Support, to investigate problems on a platform.

Generate a Report¶

Generate a report which includes logs and configuration information for container and MetalK8s components.

[artesca-os@bootstrap ~]$

sudo sos report

The archive generation can take some time, depending on the amount of data collected (size of the cluster, number of logs entries, etc…) and the time frame.

Note

By default the report collects information for the last 24 hours, but you can change the time frame using the -k metalk8s.last=48h option. However, this increases the time of generation and the size of the archive.

The name and path of the generated archive are printed in the console output.

Example of console output¶

/var/tmp/sosreport-ip-x-x-x-x-YYYY-MM-DD-<hash>.tar.xz

Where:

ip-x-x-x-x is the node IP.
YYYY-MM-DD is the date of the archive generation.
<hash> is a unique identifier.

Change the ownership¶

To operate the archive, you must change its ownership.

[artesca-os@bootstrap ~]$

sudo chown artesca-os:artesca-os /var/tmp/sosreport-*

Send a Report¶

Once the report is ready, you can send it to Scality Support.

Log in to the ftp.scality.com server using an SFTP client such as FileZilla.
Enter your OneLogin Scality credentials.

Access the Plugin List¶

Display the full list of available plugins and their options.

[artesca-os@bootstrap ~]$

sudo sos report --list-plugins