Send System Log Report: Difference between revisions
m Expand into the dedicated log-sending page and add it to the Administrator Guide: absorbs the GDPR/PII scrubbing content that was out of place on Call-home / Alerting and Security Configuration, documents the dialog fields, and refreshes the private-network procedure |
m Unwrap hard-wrapped prose lines - MediaWiki collapses a single newline inside a paragraph, so the wrapping had no effect on rendering and was inconsistent with the rest of the wiki. Rendered output is unchanged. |
||
| Line 1: | Line 1: | ||
[[Category:admin_guide]] | [[Category:admin_guide]] | ||
When you open a support case, OSNEXUS will usually ask for the system's | When you open a support case, OSNEXUS will usually 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. | ||
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. | |||
'''Navigation:''' Storage Management --> Send Support Logs ''(toolbar)'' | '''Navigation:''' Storage Management --> Send Support Logs ''(toolbar)'' | ||
It is also on the right-click context menu for a Storage System, as '''Send Log | It is also on the right-click context menu for a Storage System, as '''Send Log Report...'''. | ||
Report...'''. | |||
[[File:security_send_support_logs.png|thumb|center|800px|Send Support Log Files dialog. Several systems can be collected in one report.]] | [[File:security_send_support_logs.png|thumb|center|800px|Send Support Log Files dialog. Several systems can be collected in one report.]] | ||
| Line 23: | Line 19: | ||
* '''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. | * '''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 | An '''Advanced Settings''' tab holds additional options for less common collection scenarios. | ||
collection scenarios. | |||
Press '''OK''' to collect and upload. | Press '''OK''' to collect and upload. | ||
| Line 36: | Line 31: | ||
* much of what is under <code>/var/log/</code> | * much of what is under <code>/var/log/</code> | ||
'''QuantaStor never collects data files from your Storage Pools.''' Only system | '''QuantaStor never collects data files from your Storage Pools.''' Only system log and configuration files are included -- no volume, share or bucket contents. | ||
log and configuration files are included -- no volume, share or bucket contents. | |||
== GDPR compliance and PII scrubbing == | == GDPR compliance and PII scrubbing == | ||
To ensure no personally-identifiable information (PII) is transmitted, the log | 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 it is applied automatically -- there is nothing to enable. | ||
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 it is applied automatically -- there is nothing to | |||
enable. | |||
Combined with the fact that Storage Pool data files are never collected, the | Combined with the fact that Storage Pool data files are never collected, the bundle contains system diagnostics rather than anything identifying your users or their data. | ||
bundle contains system diagnostics rather than anything identifying your users | |||
or their data. | |||
== Outbound access and proxies == | == Outbound access and proxies == | ||
The upload goes out over HTTPS to the OSNEXUS log server, so the system needs | The upload goes out over HTTPS to the OSNEXUS log server, so the system needs outbound access. | ||
outbound access. | |||
Where appliances reach the internet through a proxy, configure it once in | 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. | ||
'''[[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. | |||
== 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 | 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. | ||
console or over SSH and retrieve the file yourself. | |||
Run this, replacing <code>companyname</code> with your organization's name, with | Run this, replacing <code>companyname</code> with your organization's name, with no spaces: | ||
no spaces: | |||
<pre> | <pre> | ||
| Line 74: | Line 55: | ||
</pre> | </pre> | ||
The command attempts the upload and will fail without outbound access -- that is | 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: | ||
expected. It still leaves the bundle in the current directory, named like: | |||
<pre> | <pre> | ||
| Line 81: | Line 61: | ||
</pre> | </pre> | ||
Copy that file off the system with any SFTP/SCP client -- WinSCP and FileZilla | Copy that file off the system with any SFTP/SCP client -- WinSCP and FileZilla both work -- and email it to your support contact. | ||
both work -- and email it to your support contact. | |||
== Related pages == | == Related pages == | ||
| Line 91: | Line 70: | ||
{{Template:ReturnToWebGuide}} | {{Template:ReturnToWebGuide}} | ||
[[Category:QuantaStor6]] | [[Category:QuantaStor6]] [[Category:WebUI Dialog]] | ||
[[Category:WebUI Dialog]] | |||
Revision as of 18:21, 2 September 2026
When you open a support case, OSNEXUS will usually 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.
Navigation: Storage Management --> Send Support Logs (toolbar)
It is also on the right-click context menu for a Storage System, as Send Log Report....
Sending a log report
The General tab covers the common case:
- 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.
- 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.
Press OK to collect and upload.
What is collected
The collection gathers:
- the system log
- system hardware configuration information
- much of what is under
/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.
GDPR compliance and PII scrubbing
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 it is applied automatically -- there is nothing to enable.
Combined with the fact that Storage Pool data files are never collected, the bundle contains system diagnostics rather than anything identifying your users or their data.
Outbound access and proxies
The upload goes out over HTTPS to the OSNEXUS log server, so the system needs outbound access.
Where appliances reach the internet through a proxy, configure it once in 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.
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.
Run this, replacing companyname with your organization's name, with no spaces:
sudo qs-sendlogs companyname
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:
qs_bug_report_<timestamp>.companyname.tgz
Copy that file off the system with any SFTP/SCP client -- WinSCP and FileZilla both work -- and email it to your support contact.
Related pages
- Alert Manager -- ongoing alert delivery by email, ITSM webhook and SNMP, which is separate from support log collection
- Security Configuration -- audit logging, and the security settings the scrubbing protects
- Storage System Modify -- proxy configuration used by the upload