Send System Log Report: Difference between revisions

From OSNEXUS Online Documentation Site
Jump to navigation Jump to search
m Restore the page footer, category and return template dropped by the previous section edit (QSTOR-12429)
Rewrite from the 6.9 product: Send Support Log Files labels, Advanced Settings options, qs-sendlogs usage and --no-upload, FTP then HTTPS upload order, skip pre-check scope, upload page for offline bundles. Removed the companyname argument, the qs_bug_report tgz file name and the HTTPS-only claim, which were wrong.
Line 1: Line 1:
[[Category:admin_guide]]
[[Category:admin_guide]]


When opening a new support ticket OSNEXUS will almost always ask for the system's configuration and log information. QuantaStor collects and uploads that bundle for you from the '''Send Support Logs''' dialog, so there is no need to gather files by hand.
When you open a support case, OSNEXUS support almost always asks for the system's logs and configuration. The '''Send Support Log Files''' dialog collects them into one bundle per system and uploads it to OSNEXUS. This page also covers systems with no Internet access and the {{Code|1=qs-sendlogs}} command.


{{Navigation|Storage Management → Send Support Logs ''(toolbar)''}}
{{Navigation|Storage Management → Storage System ''(toolbar group)'' → Send Support Log Files ''(toolbar)''}}


It is also on the right-click context menu for a Storage System, as '''Send Log Report...'''.
The dialog is also on the right-click menu of each Storage System.


[[File:security_send_support_logs.png|thumb|right|500px|Send Support Log Files dialog. Several systems can be collected in one report.]]
{{Navigation|Storage Management → Storage Systems → Storage System ''(select + right-click)'' → Send Support Log Files...}}
 
[[File:security_send_support_logs.png|thumb|right|500px|Send Support Log Files dialog, General tab. Several systems can be collected in one report.]]


== Sending a log report ==
== Sending a log report ==


The '''General''' tab covers the common case:
The '''General''' tab covers the common case.
 
* '''Select Storage System(s)''' -- tick each system to collect from. If you open the dialog with a Storage System selected, the dialog ticks only that system, and otherwise it ticks every system. The list shows each system's service, kernel and distribution version. In a grid, collect from every node involved in the problem, not only the one showing symptoms. QuantaStor skips any system in the Offline state.
* '''Support Ticket''', '''Contact Email''' and '''Message/Reason''' -- QuantaStor saves these with the logs, so the engineer who opens the bundle can match it to your case and read your description of the problem. Enter your existing case number in Support Ticket.
* '''Skip log server ping pre-checks''' -- before collecting, each system checks that it can reach the OSNEXUS log servers, and stops with the error "Support log servers ... are not accessible" if it cannot. Tick this when the check fails although the upload would get through, for example where outbound ICMP is blocked. QuantaStor skips the check on its own when a proxy is configured or uploading is disabled.
 
The skip option applies only to a report that covers just the system your browser is connected to. When a report covers other grid members, create the {{Code|1=tf_sendlogs_ping_check.disable}} touch file on each of them instead:
 
<pre style="font-size: smaller">
sudo touch /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable
</pre>


* '''Select Storage System(s)''' -- tick each system to collect from. The grid shows each system's service, kernel and distribution version, so you can confirm you are collecting from the right nodes. In a grid, collect from '''every''' node involved in the problem rather than just the one showing symptoms; most issues worth a support case span more than one system.
The '''Advanced Settings''' tab has three options, all clear by default.
* '''Support Ticket''' -- your existing case number. Filling this in is what attaches the bundle to the right case rather than leaving it to be matched up by hand.
* '''Contact Email''' -- who to reply to.
* '''Message/Reason''' -- a short description of the problem. Worth writing properly: it is the first thing the engineer reads alongside the logs.
* '''Skip log server ping pre-checks''' -- bypasses the outbound connectivity test. Use it in environments where the test does not reflect real reachability, for example where ICMP is blocked but HTTPS is permitted.


An '''Advanced Settings''' tab holds additional options for less common collection scenarios.
* '''Disable log scrubbing''' -- leaves personally identifiable information in the logs. Tick it only when OSNEXUS support asks for an unscrubbed bundle.
* '''Disable log uploading''' -- keeps the bundle on each system as an unencrypted {{Code|1=.zip}} file in {{Code|1=/var/tmp}}. Use it for systems with no Internet access. When the report covers just the system your browser is connected to, the task's Detail column shows a download link. The system serves the link on port 8889 for 30 minutes. For other grid members, copy the file off each system as described in [[#Systems on a private network|Systems on a private network]].
* '''Disable log truncation''' -- keeps large logs whole. By default, QuantaStor cuts each log file over 8 MB down to its first 3,000 and last 30,000 lines. Tick it when OSNEXUS support asks for complete logs. Collection then takes longer and the bundle is larger.


Press '''OK''' to collect and upload.
Press '''OK''' to start. Each system runs its own collection task, and the Tasks pane shows its progress.


== What is collected ==
== What is collected ==


The collection gathers:
The bundle holds:
 
* QuantaStor and system logs from {{Code|1=/var/log}}
* the output of commands that describe the hardware, operating system, network and storage configuration
* a copy of the QuantaStor configuration database


* the system log
QuantaStor never collects data from your [[Storage Pools]]. The bundle holds no volume, share or bucket contents.
* system hardware configuration information
* much of what is under {{Code|1=/var/log/}}


'''QuantaStor never collects data files from your [[Storage Pools]].''' Only system log and configuration files are included -- no volume, share or bucket contents.
== Scrubbing and encryption ==


== GDPR compliance and PII scrubbing ==
By default, QuantaStor scrubs personally identifiable information from the collected files for security and GDPR compliance. It then encrypts the bundle with the OSNEXUS support key, so only OSNEXUS support can open it, and uploads it.


To ensure no personally-identifiable information (PII) is transmitted, the log collection '''scrubs usernames and other security related information''' from the logs before they are sent to OSNEXUS. This is what makes the Send Support Logs path GDPR compliant, and this is the default mode, nothing to enable.  Data written to Storage Pools is never collected, the log bundle only contains system diagnostics and system log files rather than anything identifying users or their data.
When uploading is disabled, QuantaStor scrubs the bundle and leaves it unencrypted. Every local user on the system can read the file, so delete it from {{Code|1=/var/tmp}} once you have sent it.


== Outbound access and proxies ==
== Outbound access and proxies ==


The upload goes out over HTTPS to the OSNEXUS log server, so the system needs outbound access.
Each system uploads its own bundle, so each one needs outbound access. Without a proxy, the upload tries FTP to {{Code|1=jira.osnexus.com}} on port 21 first, then falls back to HTTPS to {{Code|1=services.osnexus.com}} on port 443. If your firewall allows port 21 but blocks FTP passive data connections, the FTP transfer can stall and keep the collection running until you stop it. On those systems, configure a proxy or disable uploading.


Where appliances reach the internet through a proxy, configure it once in '''[[Storage System#Proxy Settings|Storage System Modify --> Proxy Settings]]''' and the log upload uses it automatically, along with license activation and the [[Upgrade Manager]]. If the proxy is configured but internal traffic should bypass it, put your grid nodes in the '''No Proxy''' list.
Where systems reach the Internet through a proxy, set it in [[Storage System#Proxy Settings|Storage System Modify, Proxy Settings]]. The upload then skips FTP and goes over HTTPS through the proxy.


== Systems on a private network ==
== Systems on a private network ==


If an appliance has no route to the internet at all, generate the report at the console or over SSH and retrieve the file yourself.
Collect the bundle locally, then copy it off the system yourself. In the dialog, tick '''Disable log uploading''' on the Advanced Settings tab. At the console or over SSH, run:


Run this, replacing {{Code|1=companyname}} with your organization's name, with no spaces:
<pre style="font-size: smaller">
sudo qs-sendlogs --no-upload
</pre>
 
The command collects the logs of the system you run it on, and its last line names the file it created, for example:


<pre style="font-size: smaller">
<pre style="font-size: smaller">
sudo qs-sendlogs companyname
[SUCCESS] Successfully created log collection file '/var/tmp/example.com_qs-node1_2026-10-29_12-49-55UTC.zip' Log file has not been uploaded.
</pre>
</pre>


The command attempts the upload and will fail without outbound access -- that is expected. It still leaves the bundle in the current directory, named like:
The file name is made of the domain of the license email address, the host name and the collection time. Copy the file off the system with any SFTP or SCP client, such as WinSCP or FileZilla. From a workstation with Internet access, upload it at https://services.osnexus.com/upload/, then tell OSNEXUS support in your case that the file is there.
 
If an upload fails, the encrypted bundle stays in {{Code|1=/var/tmp}} with a {{Code|1=.zip.gpg}} extension. Copy it off and upload it the same way.
 
To stop a system from uploading logs at all, for example on a secure site, create the {{Code|1=qs_logs.no_upload}} touch file. Every collection on that system, from the dialog or from {{Code|1=qs-sendlogs}}, then leaves an unencrypted bundle in {{Code|1=/var/tmp}}.


<pre style="font-size: smaller">
<pre style="font-size: smaller">
qs_bug_report_&lt;timestamp&gt;.companyname.tgz
sudo touch /var/opt/osnexus/quantastor/touchfiles/qs_logs.no_upload
</pre>
</pre>


Copy that file off the system with any SFTP/SCP client -- WinSCP and FileZilla both work -- and email it to your support contact.
== The qs-sendlogs command ==
 
{{Code|1=qs-sendlogs}} runs the same collection as the dialog on the system where you run it, and uploads the bundle unless you tell it not to. It runs entirely on that system, so you can use it on a node that has lost contact with the rest of the grid.
 
{| class="wikitable"
! Option !! Effect
|-
| {{Code|1=--no-upload}} || Collect an unencrypted bundle and leave it in {{Code|1=/var/tmp}}.
|-
| {{Code|1=--no-scrub}} || Skip scrubbing. Use it only when OSNEXUS support asks for an unscrubbed bundle.
|-
| {{Code|1=--no-trunc}} || Keep log files over 8 MB whole.
|-
| {{Code|1=--proxy http://proxyserver:port}} || Upload over HTTPS through this proxy.
|}
 
Run {{Code|1=qs-sendlogs --help}} for the full list.


== Related pages ==
== Related pages ==


* [[Call-home / Alerting|Alert Manager]] -- ongoing alert delivery by email, ITSM webhook and SNMP, which is separate from support log collection
* [[Call-home / Alerting|Alert Manager]] -- alert delivery, which is separate from support log collection
* [[Security Configuration]] -- audit logging, and the security settings the scrubbing protects
* [[Security Configuration]] -- audit logging and the other security settings
* [[Storage System#Proxy Settings|Storage System Modify]] -- proxy configuration used by the upload
* [[Storage System#Proxy Settings|Storage System Modify]] -- the proxy configuration the upload uses
* [[QuantaStor Touch Files]] -- {{Code|1=qs_logs.no_upload}}, which permanently disables the upload on a secure-site installation
* [[QuantaStor Touch Files]] -- {{Code|1=qs_logs.no_upload}} and {{Code|1=tf_sendlogs_ping_check.disable}}


{{Template:ReturnToWebGuide}}
{{Template:ReturnToWebGuide}}

Revision as of 13:52, 29 October 2026


When you open a support case, OSNEXUS support almost always asks for the system's logs and configuration. The Send Support Log Files dialog collects them into one bundle per system and uploads it to OSNEXUS. This page also covers systems with no Internet access and the qs-sendlogs command.

Navigation: Storage Management → Storage System (toolbar group) → Send Support Log Files (toolbar)

The dialog is also on the right-click menu of each Storage System.

Navigation: Storage Management → Storage Systems → Storage System (select + right-click) → Send Support Log Files...
Send Support Log Files dialog, General tab. Several systems can be collected in one report.

Sending a log report

The General tab covers the common case.

  • Select Storage System(s) -- tick each system to collect from. If you open the dialog with a Storage System selected, the dialog ticks only that system, and otherwise it ticks every system. The list shows each system's service, kernel and distribution version. In a grid, collect from every node involved in the problem, not only the one showing symptoms. QuantaStor skips any system in the Offline state.
  • Support Ticket, Contact Email and Message/Reason -- QuantaStor saves these with the logs, so the engineer who opens the bundle can match it to your case and read your description of the problem. Enter your existing case number in Support Ticket.
  • Skip log server ping pre-checks -- before collecting, each system checks that it can reach the OSNEXUS log servers, and stops with the error "Support log servers ... are not accessible" if it cannot. Tick this when the check fails although the upload would get through, for example where outbound ICMP is blocked. QuantaStor skips the check on its own when a proxy is configured or uploading is disabled.

The skip option applies only to a report that covers just the system your browser is connected to. When a report covers other grid members, create the tf_sendlogs_ping_check.disable touch file on each of them instead:

sudo touch /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable

The Advanced Settings tab has three options, all clear by default.

  • Disable log scrubbing -- leaves personally identifiable information in the logs. Tick it only when OSNEXUS support asks for an unscrubbed bundle.
  • Disable log uploading -- keeps the bundle on each system as an unencrypted .zip file in /var/tmp. Use it for systems with no Internet access. When the report covers just the system your browser is connected to, the task's Detail column shows a download link. The system serves the link on port 8889 for 30 minutes. For other grid members, copy the file off each system as described in Systems on a private network.
  • Disable log truncation -- keeps large logs whole. By default, QuantaStor cuts each log file over 8 MB down to its first 3,000 and last 30,000 lines. Tick it when OSNEXUS support asks for complete logs. Collection then takes longer and the bundle is larger.

Press OK to start. Each system runs its own collection task, and the Tasks pane shows its progress.

What is collected

The bundle holds:

  • QuantaStor and system logs from /var/log
  • the output of commands that describe the hardware, operating system, network and storage configuration
  • a copy of the QuantaStor configuration database

QuantaStor never collects data from your Storage Pools. The bundle holds no volume, share or bucket contents.

Scrubbing and encryption

By default, QuantaStor scrubs personally identifiable information from the collected files for security and GDPR compliance. It then encrypts the bundle with the OSNEXUS support key, so only OSNEXUS support can open it, and uploads it.

When uploading is disabled, QuantaStor scrubs the bundle and leaves it unencrypted. Every local user on the system can read the file, so delete it from /var/tmp once you have sent it.

Outbound access and proxies

Each system uploads its own bundle, so each one needs outbound access. Without a proxy, the upload tries FTP to jira.osnexus.com on port 21 first, then falls back to HTTPS to services.osnexus.com on port 443. If your firewall allows port 21 but blocks FTP passive data connections, the FTP transfer can stall and keep the collection running until you stop it. On those systems, configure a proxy or disable uploading.

Where systems reach the Internet through a proxy, set it in Storage System Modify, Proxy Settings. The upload then skips FTP and goes over HTTPS through the proxy.

Systems on a private network

Collect the bundle locally, then copy it off the system yourself. In the dialog, tick Disable log uploading on the Advanced Settings tab. At the console or over SSH, run:

sudo qs-sendlogs --no-upload

The command collects the logs of the system you run it on, and its last line names the file it created, for example:

[SUCCESS] Successfully created log collection file '/var/tmp/example.com_qs-node1_2026-10-29_12-49-55UTC.zip' Log file has not been uploaded.

The file name is made of the domain of the license email address, the host name and the collection time. Copy the file off the system with any SFTP or SCP client, such as WinSCP or FileZilla. From a workstation with Internet access, upload it at https://services.osnexus.com/upload/, then tell OSNEXUS support in your case that the file is there.

If an upload fails, the encrypted bundle stays in /var/tmp with a .zip.gpg extension. Copy it off and upload it the same way.

To stop a system from uploading logs at all, for example on a secure site, create the qs_logs.no_upload touch file. Every collection on that system, from the dialog or from qs-sendlogs, then leaves an unencrypted bundle in /var/tmp.

sudo touch /var/opt/osnexus/quantastor/touchfiles/qs_logs.no_upload

The qs-sendlogs command

qs-sendlogs runs the same collection as the dialog on the system where you run it, and uploads the bundle unless you tell it not to. It runs entirely on that system, so you can use it on a node that has lost contact with the rest of the grid.

Option Effect
--no-upload Collect an unencrypted bundle and leave it in /var/tmp.
--no-scrub Skip scrubbing. Use it only when OSNEXUS support asks for an unscrubbed bundle.
--no-trunc Keep log files over 8 MB whole.
--proxy http://proxyserver:port Upload over HTTPS through this proxy.

Run qs-sendlogs --help for the full list.

Related pages

Return to Using the Web Interface


Verified against QuantaStor 6.9.0.