[asterisk-commits] lmadsen: branch 1.4 r256900 - /branches/1.4/doc/

[SVN commits to the Asterisk project]

Author: lmadsen
Date: Mon Apr 12 12:29:26 2010
New Revision: 256900

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=256900
Log:
Add How-To document on collecting debugging info for issues.asterisk.org

Paul Belanger has been helping a lot with bug tracking recently and created
this document that we can now point to when additional debugging information
is required. This document will help those filing issues to know how to get
the information required when filing their issues. This will make things
easier on the developers.

Initial text and changes by pabelanger. Tweaks and editing by myself.

(closes issue #17159)
Reported by: pabelanger
Patches: 
      HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
Tested by: tzafrir, pabelanger, lmadsen

Added:
    branches/1.4/doc/HOWTO_collect_debug_information.txt   (with props)

Added: branches/1.4/doc/HOWTO_collect_debug_information.txt
URL: http://svnview.digium.com/svn/asterisk/branches/1.4/doc/HOWTO_collect_debug_information.txt?view=auto&rev=256900
==============================================================================
--- branches/1.4/doc/HOWTO_collect_debug_information.txt (added)
+++ branches/1.4/doc/HOWTO_collect_debug_information.txt Mon Apr 12 12:29:26 2010
@@ -1,0 +1,89 @@
+===============================================================================
+===
+=== HowTo: Collect Debug Information for the Asterisk Issue Tracker
+===
+=== Written by: Paul Belanger
+=== Last updated: 2010-04-12
+===============================================================================
+
+This document will provide instructions on how to collect debugging logs from an
+Asterisk machine, for the purpose of helping bug marshals troubleshoot an issue
+on https://issues.asterisk.org
+-------------------------------------------------------------------------------
+--- PREREQUISITES
+-------------------------------------------------------------------------------
+
+- Asterisk 1.4.30 or greater.
+
+-------------------------------------------------------------------------------
+--- STEPS
+-------------------------------------------------------------------------------
+
+1. Edit the logger.conf file to enable debug output to your filesystem.
+
+   Add the following line. The word "myDebugLog" can be changed to anything you
+   want, as that is the filename the logging will be written to. A good example
+   might be something like: issue_12345_full_log
+
+   myDebugLog => notice,warning,error,debug,verbose,dtmf
+
+2. From the Asterisk CLI, restart the logger module:
+
+   *CLI> core set verbose 15
+   *CLI> core set debug 15
+   *CLI> module reload logger
+
+   Optionally, if you've used this file to record data previously, then rotate
+   the logs:
+
+   *CLI> logger rotate
+
+2.1. Depending on your issue, be sure to enable the channel driver logging.
+
+     SIP (1.6.0 or higher)
+
+        *ClI> sip set debug on
+
+     SIP (1.4)
+
+        *CLI> sip set debug
+
+     IAX2 (1.6.0 or higher)
+
+        *CLI> iax2 set debug on
+
+     IAX2 (1.4)
+
+        *CLI> iax2 set debug
+
+3. Reproduce your issue.
+
+4. Once finished, be sure to disable the extra debbuging:
+
+   *CLI> core set verbose 0
+   *CLI> core set debug 0
+
+4.1. Again, remember to disable any extra logging if you enabled it in the
+     channel driver.
+
+     SIP (1.4 or higher)
+
+        *ClI> sip set debug off
+
+     IAX2 (1.4 or higher)
+
+        *CLI> iax2 set debug off
+
+5. Upload the file located in /var/log/asterisk/myDebugLog to the issue tracker.
+
+   *** IMPORTANT ***
+   Do NOT post the output of your file as a comment. This clutters the issue
+   and will only result in your comment being deleted.
+
+6. Disable logging to the filesystem. Edit the logger.conf file and comment out
+   or delete the line you added in step 1. Using a semi-colon as the first
+   character on the line will comment out the line.
+
+   Then reload the logger module like in step 2:
+
+   *CLI> module reload logger

Propchange: branches/1.4/doc/HOWTO_collect_debug_information.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: branches/1.4/doc/HOWTO_collect_debug_information.txt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: branches/1.4/doc/HOWTO_collect_debug_information.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain