Differences

This shows you the differences between two versions of the page.

--- litespeed_wiki:config:bug-reporting [2019/04/02 16:10]
Jackson Zhang
+++ litespeed_wiki:config:bug-reporting [2019/04/02 18:31]
Lisa Clarke Copyediting
@@ Line 1: / Line 1: @@
-====== How to submit a bug report ======
+====== How to Submit a Bug Report ======
-==== Always upgrade to the latest version of Latest build before submitting a report ====
-There are two cases you can log a bug report.
+**NOTE**: Always upgrade to the latest build of the latest version before submitting a report!
-One case when the server crashed and core files were generated at /tmp/lshttpd/bak_core/, you can submit a server crash report.
+There are two cases where you can log a bug report:
-The other case is server doesn't crash at all, but LSWS doesn't work as expected, especially it works with apache but doesn't work with LSWS in the control panel environment. In this situation, you can turn on debug logging when reproducing the issue, then send the detailed debug log for us to investigate.
-Before you log such server crash bug report to us, it is always a good practice to check which release version and which BUILD caused such crash.
+  - Server Crash Report: Submit if the server crashes and core files were generated at ''/tmp/lshttpd/bak_core/''
+  - Bug Report: Submit if the server doesn't crash, but LSWS doesn't work as expected, especially when the same thing works with Apache in a control panel environment. Turn on debug logging when reproducing the issue, then send the detailed debug log for us to investigate.
+Before you submit any such report to us, it is always a good practice to check which release version and which BUILD caused the issue:
   cat /usr/local/lsws/VERSION
   cat /usr/local/lsws/BUILD
-If it is still an old version or old build, please always run the force upgrade command so that you are using the latest build of the latest version. This action alone may fix your problem.
+If it is an old version or build, please run the force upgrade command and check again. This action alone may fix your problem.
   /usr/local/lsws/admin/misc/lsup.sh -f -v <latest_version_number>
-then monitor your server to see if it happens again or not. If yes, please take the following steps to log the server crash report.
+Monitor your server to see if the issue recurrs. If it does, please take the following steps, as appropriate, to log a report.
-===== Submit a server crash report =====
+===== Submit a Server Crash Report =====
-New version/new build of web server may hit the bug, crash and generate core files at /tmp/lshttpd/bak_core/core.*. Normally you will receive some email alert on this situation. You are welcome to sumbit such server crash report to us, either forwarding the alert email to us or forwarding core files to bug@litespeedtech.com.
+A new version or new build of LiteSpeed Web Server may have an undiscovered bug, crash, and generate core files at ''/tmp/lshttpd/bak_core/core.*''. You should normally receive an email alert when this happens. You are welcome to submit a server crash report, either by forwarding the alert email or forwarding core files to ''bug@litespeedtech.com''.
-==== Email alert received with debug info ====
+==== Email Alert With Debug Info ====
-You may receive an email alert similar to the following if crash happened again after force upgrade:
+You may receive an email alert similar to the following, if another crash happens again after a forced upgrade:
 <code>
@@ Line 220: / Line 219: @@
   fs 0x0 0
   gs 0x0 0
+</code>
-This means that LiteSpeed Web Server crashed, and core files have been created at ''/tmp/lshttpd/bak_core''. You can foward the above email to bug@litespeedtech.com.
+This means that LiteSpeed Web Server crashed, and core files have been created at ''/tmp/lshttpd/bak_core''.
   ll /tmp/lshttpd/bak_core
   drwxr-xr-x 2 root   nobody     4096 May  3  2018 ./
@@ Line 228: / Line 227: @@
   -rw------- 1 nobody nobody 53587968 May  3  2018 core.2578440
-==== Email alert received without debug info ====
+==== Email Alert Without Debug Info ====
-If you receive an email similar to the following without backtrace information:
+You may receive an email alert similar to the following, without backtrace information:
 <code>
@@ Line 247: / Line 246: @@
 </code>
-please install gdb first, also install LSWS debug build:
+Please install gdb first, followed by a LSWS debug build:
     /usr/local/lsws/admin/misc/lsup.sh -d -f -v <latest_version_number>
-then wait for next crash then foward the email with debug info to bug@litespeedtech.com.
+Then, wait for the next crash. After that crash you will receive an email alert with the debug info and you can forward it to ''bug@litespeedtech.com''.
-===== Submit a bug report with detailed debug log =====
+===== Submit a Bug Report =====
-The other case is server doesn't crash at all, but LSWS doesn't work as expected, especially it works with apache but doesn't work with LSWS in the control panel environment. In this case, you may want to enable high level debug log on LSWS to reproduce the issue and send such detailed debug log for our developer to investigate along with detailed steps to reproduce the problem.
+If the server doesn't crash, but it's not working as expected, particularly if the same task //does// work in Apache, you can submit a bug report.
+Enable a high-level debug log on LSWS to reproduce the issue, and send the detailed debug log to ''bug@litespeedtech.com''. Be sure to include the detailed steps to reproduce the problem so that our developers may investigate.
-How to toggle the debug logging and capture detailed debug log?
+==== How to Toggle Debug Logging and Capture Output ====
-Let's give an example on a cpanel EA4 envirment. One PHP URl/request work with Apache but doesn't work with LSWS. Go to the logs folder:
+Let's give an example in a cPanel EA4 environment. One PHP URL/request works with Apache, but it doesn't work with LSWS. Go to the logs folder:
   cd /etc/apache2/logs
-  ## backup/or delete old error_log
+Back up or delete old ''error_log'':
   mv error_log error_log.old
-  ##toggle litespeed server debug log, run once to turn on, run again to turn off. This is to turn on##
+Toggle LiteSpeed server debug log (run once to turn on, run again to turn off):
   killall -USR2 litespeed
-  ## then from your brower to reproduce the issue
-  ## reproduce the issue
+Reproduce the issue in your browser.
-  ##toggle litespeed server debug log, This time to turn it off##
+Toggle the debug log off:
   killall -USR2 litespeed
+Move the debug log to ''error_log.debug'':
   mv error_log error_log.debug
-The error_log.debug could be very big if it is a very busy shared production server since it could be many domains servicing requests at the same time. It might be good to just focus on the IP of your location.
+The ''error_log.debug'' file could be very big if it is a busy shared production server, since there could be many domains servicing requests at the same time. It might be good to just focus on the IP of your location. (You can easily find your own IP by searching ''IP'' at google.com.)
+  grep your_IP error_log.debug > error_log.debug.ip
-You can easliy find your own IP by typing "IP" from google.com.
+(Substitute your actual IP address where it says ''your_IP''.)
-then
+You can then forward ''error_log.debug.ip'' along with detailed steps to reproduce issue to ''bug@litespeedtech.com'' for investigation.
-  grep your_IP error_log.debug > error_log.debug.ip
-You can then forward ''error_log.debug.ip'' along with detailed steps to reproduce issue to bug@litespeedtech.com for investigation.