diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index f9ea1ceb..2b0a6e2c 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -6,6 +6,42 @@ In its default configuration, your auth project logs INFO and higher messages to To record DEBUG messages in the log file, alter a setting in your auth project's settings file: `LOGGING['handlers']['log_file']['level'] = 'DEBUG'`. After restarting gunicorn and celery, your log file will record all logging messages. +## Steps to Check Logs for Errors + +### Locate the Logs: + +The logs are located within the `myauth/log/` directory of your Alliance Auth project. + +### Access the Logs: + +Use a text editor or terminal commands (like `tail -f `) to open the relevant log files. + +_(The `tail -f` command displays the last few lines of a file and then continues to monitor the file, printing any new lines that are added in real-time. Useful to watch while actively testing a troublesome feature while troubleshooting.)_ + +Consider the following: + +`allianceauth.log` is the primary log for general troubleshooting. Tracks user actions, changes made, and potential errors. + +`worker.log` is important for issues related to background tasks.(Such as services(Discord)). + +`beat.log` if you suspect scheduler problems. + +`gunicorn.log` for web-specific or Gunicorn worker errors. + +### Search for Errors: + +Look for keywords like `ERROR`, `WARNING`, `EXCEPTION`, or `CRITICAL`. Examine timestamps to correlate errors with user actions or events. Read the error messages carefully for clues about the problem's nature. + +Troubleshooting Tips: + +**Filter Logs:** Use tools like `grep` to filter logs based on keywords or timeframes, making it easier to focus on relevant information. + +**Example**: `tail -f worker.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see among the other logs. + +**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your `local.py` to get more detailed messages. Remember to set it back to `False` after debugging. + +**Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.** + ## Common Problems ### I'm getting error 500 when trying to connect to the website on a new installation