From cd738137c05ff4ce7e3d219a28631e6c961116a7 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:52:07 +0000 Subject: [PATCH 01/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index f9ea1ceb..040a26e2 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -33,6 +33,35 @@ Press Control+C once. Now start the worker again with `supervisorctl start myauth:worker` +## 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 for debugging.) +Consider the following: +`allianceauth.log` is the primary log for general troubleshooting. +`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 allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see amoung the other logs. +**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth settings to get more detailed messages. Remember to revert to INFO level after debugging. + +**Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.** + ### Proxy timeout when entering email address This usually indicates an issue with your email settings. Ensure these are correct and your email server/service is properly configured. From 4f876b648bcb539ea1521f1a7bbab83eebb1bf90 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:53:16 +0000 Subject: [PATCH 02/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 50 ++++++++++++++--------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 040a26e2..6c860586 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -8,31 +8,6 @@ To record DEBUG messages in the log file, alter a setting in your auth project's ## Common Problems -### I'm getting error 500 when trying to connect to the website on a new installation - -*Great.* Error 500 is the generic message given by your web server when *anything* breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it. - -### Failed to configure log handler - -Make sure the log directory is writeable by the allianceserver user: `chmown -R allianceserver:allianceserver /path/to/myauth/log/`, then restart the auth supervisor processes. - -### Groups aren't syncing to services - -Make sure the background processes are running: `supervisorctl status myauth:`. If `myauth:worker` or `myauth:beat` do not show `RUNNING` read their log files to identify why. - -### Task queue is way too large - -Stop celery workers with `supervisorctl stop myauth:worker` then clear the queue: - -```shell -redis-cli FLUSHALL -celery -A myauth worker --purge -``` - -Press Control+C once. - -Now start the worker again with `supervisorctl start myauth:worker` - ## Steps to Check Logs for Errors ### Locate the Logs: @@ -62,6 +37,31 @@ Troubleshooting Tips **Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.** +### I'm getting error 500 when trying to connect to the website on a new installation + +*Great.* Error 500 is the generic message given by your web server when *anything* breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it. + +### Failed to configure log handler + +Make sure the log directory is writeable by the allianceserver user: `chmown -R allianceserver:allianceserver /path/to/myauth/log/`, then restart the auth supervisor processes. + +### Groups aren't syncing to services + +Make sure the background processes are running: `supervisorctl status myauth:`. If `myauth:worker` or `myauth:beat` do not show `RUNNING` read their log files to identify why. + +### Task queue is way too large + +Stop celery workers with `supervisorctl stop myauth:worker` then clear the queue: + +```shell +redis-cli FLUSHALL +celery -A myauth worker --purge +``` + +Press Control+C once. + +Now start the worker again with `supervisorctl start myauth:worker` + ### Proxy timeout when entering email address This usually indicates an issue with your email settings. Ensure these are correct and your email server/service is properly configured. From 8eaa94e179939ce5eb4793602e101c664f1533fc Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:55:24 +0000 Subject: [PATCH 03/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 6c860586..cb23093d 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -2,9 +2,13 @@ ## Logging -In its default configuration, your auth project logs INFO and higher messages to myauth/log/allianceauth.log. If you're encountering issues, it's a good idea to view DEBUG messages as these greatly assist the troubleshooting process. These are printed to the console with manually starting the webserver via `python manage.py runserver`. +In its default configuration, your auth project logs INFO and higher messages to myauth/log/allianceauth.log. +If you're encountering issues, it's a good idea to view DEBUG messages as these greatly assist the troubleshooting process. +These are printed to the console with manually starting the webserver via `python manage.py runserver`. -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. +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. ## Common Problems @@ -17,7 +21,8 @@ The logs are located within the `myauth/log/` directory of your Alliance Auth pr ### 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 for debugging.) +_(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 for debugging.)_ Consider the following: `allianceauth.log` is the primary log for general troubleshooting. `worker.log` is important for issues related to background tasks.(Such as services(Discord)). @@ -31,9 +36,12 @@ 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 allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see amoung the other logs. -**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth settings to get more detailed messages. Remember to revert to INFO level after debugging. +**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 allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. +Making it easier to see amoung the other logs. +**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth +settings to get more detailed messages. Remember to revert to INFO level after debugging. **Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.** From f9cbfb156256d2e6b2576c75837d4332ddf3c818 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:55:59 +0000 Subject: [PATCH 04/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index cb23093d..1b2121e1 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -21,7 +21,7 @@ The logs are located within the `myauth/log/` directory of your Alliance Auth pr ### 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, +_(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 for debugging.)_ Consider the following: `allianceauth.log` is the primary log for general troubleshooting. From 96abae553ac122ed936e93f66a10e767cc40373d Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:57:12 +0000 Subject: [PATCH 05/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 1b2121e1..0722cbca 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -38,8 +38,10 @@ 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 allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see amoung the other logs. + **Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth settings to get more detailed messages. Remember to revert to INFO level after debugging. From 3bf5bc0fe340e960913ac3ad4d356f2bb39d9baf Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:58:09 +0000 Subject: [PATCH 06/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 0722cbca..cc89391c 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -40,7 +40,7 @@ Troubleshooting Tips making it easier to focus on relevant information. **_Example_**: `tail -f allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. -Making it easier to see amoung the other logs. +Making it easier to see among the other logs. **Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth settings to get more detailed messages. Remember to revert to INFO level after debugging. From daad7d8b10382070454f674bc635091eea3a47cc Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:58:44 +0000 Subject: [PATCH 07/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index cc89391c..619ec8ba 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -21,12 +21,18 @@ The logs are located within the `myauth/log/` directory of your Alliance Auth pr ### 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 for debugging.)_ + Consider the following: + `allianceauth.log` is the primary log for general troubleshooting. + `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: From df276cb32d74ae00e66fffaea6d5f95be9327c95 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 00:59:19 +0000 Subject: [PATCH 08/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 619ec8ba..b92f5f9c 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -45,7 +45,7 @@ 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 allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. +**_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 Alliance Auth From 39146263799e39d74d99de73a0809fe609d423aa Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:04:59 +0000 Subject: [PATCH 09/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index b92f5f9c..8c8288f3 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -40,6 +40,7 @@ Consider the following: 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, From 1711a9dd3332f183c172a556c94697cde397a017 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:05:25 +0000 Subject: [PATCH 10/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 8c8288f3..29a4f4b4 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -10,8 +10,6 @@ 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. -## Common Problems - ## Steps to Check Logs for Errors ### Locate the Logs: @@ -54,6 +52,8 @@ settings to get more detailed messages. Remember to revert to INFO level after d **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 *Great.* Error 500 is the generic message given by your web server when *anything* breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it. From bee652218256ef0abb18a18725da184740fb2fb4 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:07:08 +0000 Subject: [PATCH 11/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 29a4f4b4..111a4c85 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -25,7 +25,7 @@ printing any new lines that are added in real-time. Useful to watch while active Consider the following: -`allianceauth.log` is the primary log for general troubleshooting. +`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)). From 51e4dd986f25308153a23bb7cd3066df68d7e09a Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:09:56 +0000 Subject: [PATCH 12/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 111a4c85..ee13e68c 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -48,7 +48,7 @@ making it easier to focus on relevant information. Making it easier to see among the other logs. **Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth -settings to get more detailed messages. Remember to revert to INFO level after debugging. +settings 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.** From 6da50da92fbf18b013fa7ef109a9a1a2c0ba5905 Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:10:38 +0000 Subject: [PATCH 13/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index ee13e68c..064a6d48 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -48,7 +48,7 @@ making it easier to focus on relevant information. Making it easier to see among the other logs. **Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth -settings to get more detailed messages. Remember to set it back to false after debugging. +settings 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.** From d7fe09bdf18f40057b613802051de6e115756f2f Mon Sep 17 00:00:00 2001 From: AnomicDev Date: Sun, 14 Apr 2024 01:19:51 +0000 Subject: [PATCH 14/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 064a6d48..96d64036 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -21,7 +21,7 @@ The logs are located within the `myauth/log/` directory of your Alliance Auth pr 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 for debugging.)_ +printing any new lines that are added in real-time. Useful to watch while actively testing a troublesome feature while troubleshooting.)_ Consider the following: From 64686cdad1ed076cda334b8948807e3dbb91d2ce Mon Sep 17 00:00:00 2001 From: entropylaw Date: Sat, 13 Apr 2024 20:49:46 -0500 Subject: [PATCH 15/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 96d64036..3924bb73 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -39,7 +39,7 @@ 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 +Troubleshooting Tips: **Filter Logs:** Use tools like `grep` to filter logs based on keywords or timeframes, making it easier to focus on relevant information. From 3d206e445c930e9cdccb1efda4c3104f0d4384e0 Mon Sep 17 00:00:00 2001 From: entropylaw Date: Sat, 13 Apr 2024 20:55:10 -0500 Subject: [PATCH 16/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 3924bb73..58879157 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -47,8 +47,8 @@ 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 Alliance Auth -settings to get more detailed messages. Remember to set it back to `false` after debugging. +**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.** From 08dc88da1aa4d5c2e24a82f3271bbf7e9ecfa039 Mon Sep 17 00:00:00 2001 From: entropylaw Date: Sat, 13 Apr 2024 20:59:19 -0500 Subject: [PATCH 17/18] Update troubleshooting.md --- docs/maintenance/troubleshooting.md | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 58879157..5545eb04 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -2,13 +2,9 @@ ## Logging -In its default configuration, your auth project logs INFO and higher messages to myauth/log/allianceauth.log. -If you're encountering issues, it's a good idea to view DEBUG messages as these greatly assist the troubleshooting process. -These are printed to the console with manually starting the webserver via `python manage.py runserver`. +In its default configuration, your auth project logs INFO and higher messages to myauth/log/allianceauth.log. If you're encountering issues, it's a good idea to view DEBUG messages as these greatly assist the troubleshooting process. These are printed to the console with manually starting the webserver via `python manage.py runserver`. -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. +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 @@ -20,8 +16,7 @@ The logs are located within the `myauth/log/` directory of your Alliance Auth pr 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.)_ +_(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: @@ -35,20 +30,15 @@ Consider the following: ### 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. +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. +**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. +**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. +**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.** From 634e7357befae82d678da1c569053b009f1450d5 Mon Sep 17 00:00:00 2001 From: entropylaw Date: Sat, 13 Apr 2024 21:21:13 -0500 Subject: [PATCH 18/18] Update troubleshooting.md. Fixed Typo. --- docs/maintenance/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 5545eb04..2b0a6e2c 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -38,7 +38,7 @@ Troubleshooting Tips: **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. +**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.**