Difference between revisions of "Unraid 6/Troubleshooting"

From unRAID
Jump to: navigation, search
(Capturing Diagnostics)
m (Capturing Diagnostics)
Line 25: Line 25:
 
put the resulting zip file into the '''logs''' folder on the flash drive.
 
put the resulting zip file into the '''logs''' folder on the flash drive.
  
[[Diagnostics.jpg|250px|thumb|right|Diagnostics]]
+
[[File:Diagnostics.jpg|250px|thumb|right|Diagnostics]]
  
 
These system diagnostics include configuration information, state information and key system logs.
 
These system diagnostics include configuration information, state information and key system logs.

Revision as of 07:11, 3 January 2020

Official Documentation Contents List

Troubleshooting

THIS SECTION IS STILL UNDER CONSTRUCTION

A lot more detail still needs to be added

Most of the time Unraid systems function with minimal problems. This section is intended to help with resolving issues that are most commonly encountered.

There are some important general guidelines that it is recommended that a user follows that will help with any troubleshooting that may be required:

  • Enable Notifications: Unraid has a notification system that can be used to keep you informed about the health of your Unraid system. This can be enabled and the level of notifications you receive tuned under Settings->User Preferences->Notification Settings. Since Unraid systems often function for very long times without needing any user oversight it can be important that you are informed problems when they first occur as if left unresolved they can grow into more serious ones.
  • Proactively fix any reported issues:
  • Ask for help in the forums: Unraid has a vibrant user community and many knowledgeable users who are active in the Unraid forums. Any time you encounter a problem and you are not sure how to proceed it is a good idea to ask questions in the forums. There is nothing worse than rushing into trying to fix a problem using a process you do not understand and as a result making a problem that was initially easy to resolve into something more serious
  • Capture diagnostics: If you want to ask a question in the forums about a problem you are encountering you are frequently going to be asked to provide your system diagnostics file.

Capturing Diagnostics

Diagnostics

Unraid has a GUI option under Tools->Diagnostics to capture a lot of information about the state of your system that can be helpful when trying to diagnose any issues. Using this tool will result in a zip file being produced that can be downloaded and then attached to forum posts. If the GUI cannot be accessed for any reason then using the diagnostics command from the Linux level will generate the same information and put the resulting zip file into the logs folder on the flash drive.

Diagnostics

These system diagnostics include configuration information, state information and key system logs. When creating the diagnostics from the GUI then details of the sort of information that will be included is listed. The diagnostics are anonymized to try and avoid including any information that might be deemed sensitive. All the files in the diagnostics are text files so a user is free to examine them to check for themselves exactly what information is present.

Note on anonymization of the diagnostics
It has been pointed out that the diagnostics are not completely anonymized if you have enabled mover logging under Settings->Mover Settings as the syslog will give the names of files that mover is operating on. This is a bit of a catch-22 scenario as when one has enabled mover logging it is normally to investigate a problem where as much detail as terrible is captured so attempting to anonymize such information may well be counter-productive. Since mover logging is disabled by default and recommended practice is to only have it enabled when investigating why mover is not giving the expected results this is probably acceptable?

Persistent Logs

The main system log is the syslog file and it is the contents of this file that is displayed when you click the log icon at the top right of the Unraid GUI.

Normally the logs are only written to RAM so do not survive the system being rebooted. If you are investigating a system crash then as long as you are running Unraid 6.7.2 or later you can go to Settings->Network Services->Syslog Server and enable the server

Syslog server
  • Tick the Mirror to Flash option to get a syslog that survives a crash written to the flash drive and is appended to on a reboot. You do not want to leave the Mirror to Flash option ticked if you are not investigating a problem where you cannot get the normal system diagnostics as this can cause a lot of additional writes to the flash drive that can shorten it's lifetime.
  • You can also enter the name or IP address of your Unraid server into the Remote syslog server field and enter a local share where such a file can be stored under the Local syslog folder field. In this case a share set to use the cache drive is recommended to avoid spinning up array drives unnecessarily. This is more appropriate if you wand to continue to keep a permanent copy of the syslog.

Notes:

  • The system diagnostics include the syslog so there is no need to provide this separately.



Boot Issues

THIS SECTION IS STILL UNDER CONSTRUCTION


Crash Issues

THIS SECTION IS STILL UNDER CONSTRUCTION


Data Recovery

THIS SECTION IS STILL UNDER CONSTRUCTION

A lot more detail still needs to be added

This section is about recovering your data when Unraid reports problems with one or more drives.

There are some important points to bear in mind about securing your data(

  • Backup critical data: Unraid will protect you against most types of simple hardware failure, but not catastrophic failure. You should ALWAYS have backups of any critical data that you cannot afford to lose. Ideally one of those copies should be offsite or on the cloud to protect yourself against unforeseen issues such as fire, theft, flood, etc.
    • Each user has to make their own determination of what they deem critical and make an assessment of the level of risk they are prepared to take.
    • Personal data such as photographs & documents tend to always be deemed critical. Luckily these tend to be relatively small so easy to back up.
    • Media files are often deemed non-critical and are relatively large so a user may well decide these do not merit being backed up
    • Personal video that can never be replaced should fall into the critical category regardless of it's size
    • Remember that there are things such as ransomware around so there should be at least one copy of critical files that cannot be accessed online and corrupted if you are unfortunate enough to suffer from such an attack!
  • Be pro-active about resolving any issues that are detected by Unraid. Make sure that notifications are enabled under Settings->Notifications so that you get told as soon as issues are detected. For many users Unraid operates in a fire-and-forget mode so that they will not be actively checking for problems so need such reminders.
  • Ask for Advice:
    • The Unraid forums have lots of knowledgeable users who can help guide you through what needs doing to get your data back into a standard if you are not sure what are the best steps to take.
    • Unraid is very good about protecting your data against typical hardware failures , but it is not immune against users taking inappropriate steps to recover their data after a failure occurs.