Skip to content

Commit

Permalink
Merge pull request #2371 from truenas/PD-707-Expand-SCAKE-Debug-Infor…
Browse files Browse the repository at this point in the history
…mation

PD-707 Expand Debug Information
  • Loading branch information
DjP-iX committed Dec 21, 2023
2 parents 32a3908 + f69dfbc commit a819428
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions content/SCALE/GettingStarted/Getting Support/FileIssueSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,24 @@ Attach any applicable screenshots and click **Save**.
After the ticket generates, the **Ticket** confirmation dialog opens. Click **Open Ticket** to view the ticket in Jira.

![GeneralSettingsSCALEJiraTicketLink](/images/SCALE/SystemSettings/GeneralSettingsSCALEJiraTicketLink.png "SCALE General Settings Jira Ticket Link")

### Creating an Issue In Jira

If logging into Jira and creating an issue ticket, Use **Save Debug** on the top of the **System Settings > Advanced** screen to download a system debug after the issue occurs and before you reboot the system to capture log files necessary to troubleshoot and diagnose system issues.

{{< hint type=warning title="Debug Files Contain Sensitive Information">}}
System debugs contain log files which can include personal information such as usernames, and other identifying information about your system such as networking configuration, device serial numbers, etc.
Users can use a file archiver utility, such as 7-Zip File Manager, to open compressed debug archives and review log contents.
Redact any personal data you have concerns about sharing and save the debug file before attaching and linking it to a Jira ticket in the TrueNAS project.
{{< /hint >}}

Always store debug files in a secure location.

To protect user data privacy, the TrueNAS Jira project sends the issue reporter a link to a private file attachment area where they can upload their debug file and link the upload ticket to their issue report ticket.
This link is in the system-generated response in the ticket.
We encourage users to use the [link](https://ixsystems.atlassian.net/servicedesk/customer/portal/15/group/37/create/153) in the automated report response to keep the debug file secure and restrict access to only those that require the information to diagnose the cause of the issue reported.
When reporting issues though the SCALE UI, if you click **Attach Debug** it automatically attaches the system debug file to a private attachment ticket and link that ticket to the issue report ticket.

You can attach the debug directly to the issue ticket if you are not concerned about others accessing the debug file, but we do not recommend this practice.
Issues tickets with debug files are marked private during the triage process, which can lead to duplicated reports of the same issue when another user cannot find an existing report that is marked private.
Duplicate reports of the same issue are closed to allow Engineering staff to focus their efforts on the original issue report.

0 comments on commit a819428

Please sign in to comment.