[Home]

Summary:ASTERISK-15935: [patch] HowTo: Collecting Debug Information
Reporter:Paul Belanger (pabelanger)Labels:
Date Opened:2010-04-09 12:20:26Date Closed:2010-04-12 12:31:35
Priority:MajorRegression?No
Status:Closed/CompleteComponents:Documentation
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) HOWTO_collect_debug_information.txt.patch
( 1) HowTo:Collect.Debug.Information.txt
( 2) HowTo:Collect.Debug.Information.v2.txt
( 3) HowTo-Collect.Debug.Information-v3-ljam.txt
( 4) HowTo-Collect.Debug.Information-v4-ljam.txt
Description:In an effort to help reporters and developers work together, I have created a HowTo document to help collect debug information. This will help people reporting an issue collect useful information for a developer.

****** ADDITIONAL INFORMATION ******

Please comment on the document.
Comments:By: Tzafrir Cohen (tzafrir) 2010-04-10 07:26:38

a. Maximal verbosity and debug levels:

$ grep -h -o 'ast_verb([^,]*,' */*.c | sort | uniq -c
   126 ast_verb(0,
   136 ast_verb(1,
     2 ast_verb(10,
     6 ast_verb(11,
   122 ast_verb(2,
   498 ast_verb(3,
    64 ast_verb(4,
     7 ast_verb(6,
     1 ast_verb(level,

"level" is from res_agi, where it comes from the user.
10 and 11 seem at first glance to be ones that may be safely changed to be 5 or so.

For ast_debug we get:

grep -h -o 'ast_debug([^,]*,' */*.c | sort | uniq -c
     9 ast_debug(0,
  1513 ast_debug(1,
     4 ast_debug(10,
     1 ast_debug(1000,
   171 ast_debug(2,
   243 ast_debug(3,
   132 ast_debug(4,
    37 ast_debug(5,

Likewise, I suspect that the 4 "10"-s and the single "1000" could be safely changed to lower values.

Often the driver-level traces (sip debug, iax2 debug, pri set debug, and such) are confusing.

Another thing to note is that as of asterisk 1.6.<I'm not sure, exactly>, you can set debug specifically on source files. In trunk this has been made possible to use per module. Thus it may be nicer to disable most debugs, but still have debugging enabled on some files.
By: Paul Belanger (pabelanger) 2010-04-10 13:43:11

Do we want to establish a 'range' or limit for ast_debug and ast_verbose for developers?  I agree, 999 is a high number to set.  But like tzafrir said on IRC:

  <tzafrir_laptop> The funning thing that 999 is not high enough. One debug message is 1000 :-)
By: Leif Madsen (lmadsen) 2010-04-12 10:18:39

Well generally I think it has been accepted that most messages are found from 4 or below. With the debug messages it seems to be around 5 and below.

I think it might make sense to clean this up a bit and change the debug level logging to between 0 and 10?

What is the log for 1000? I presume it is that high because whoever put it in didn't want it seen unless they REALLY meant for it to be seen?
By: Paul Belanger (pabelanger) 2010-04-12 10:29:25

Version 2:
- Changed verbose 999 to verbose 15.
- Added 'dtmf' to full log.
- Removed Notes section (was empty).
By: Leif Madsen (lmadsen) 2010-04-12 10:41:39

Version 3:
- Added changes from version 2
- Reformatted a bit to look like other documentation we have (i.e. distributed_devicestate.txt)
- Added information for debugging Asterisk 1.4 as well
By: Leif Madsen (lmadsen) 2010-04-12 10:44:50

Version 4:
- Added more info to step 4 about how to turn off debugging
- Fixed the IAX2 enable debug command
By: Leif Madsen (lmadsen) 2010-04-12 10:50:13

Created a patch based on version 4 and uploaded it here.
By: Digium Subversion (svnbot) 2010-04-12 11:16:44

Repository: asterisk
Revision: 256860

U   trunk/apps/app_voicemail.c

------------------------------------------------------------------------
r256860 | lmadsen | 2010-04-12 11:16:43 -0500 (Mon, 12 Apr 2010) | 3 lines

Remove silly debug message that is not useful.

(issue ASTERISK-15935)
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256860
By: Digium Subversion (svnbot) 2010-04-12 11:17:21

Repository: asterisk
Revision: 256862

_U  branches/1.6.2/
U   branches/1.6.2/apps/app_voicemail.c

------------------------------------------------------------------------
r256862 | lmadsen | 2010-04-12 11:17:21 -0500 (Mon, 12 Apr 2010) | 11 lines

Merged revisions 256860 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

........
 r256860 | lmadsen | 2010-04-12 11:16:43 -0500 (Mon, 12 Apr 2010) | 3 lines
 
 Remove silly debug message that is not useful.
 
 (issue ASTERISK-15935)
........

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256862
By: Digium Subversion (svnbot) 2010-04-12 12:29:28

Repository: asterisk
Revision: 256900

A   branches/1.4/doc/HOWTO_collect_debug_information.txt

------------------------------------------------------------------------
r256900 | lmadsen | 2010-04-12 12:29:27 -0500 (Mon, 12 Apr 2010) | 15 lines

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 ASTERISK-15935)
Reported by: pabelanger
Patches:
     HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
Tested by: tzafrir, pabelanger, lmadsen
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256900
By: Digium Subversion (svnbot) 2010-04-12 12:29:54

Repository: asterisk
Revision: 256901

_U  trunk/
A   trunk/doc/HOWTO_collect_debug_information.txt

------------------------------------------------------------------------
r256901 | lmadsen | 2010-04-12 12:29:53 -0500 (Mon, 12 Apr 2010) | 23 lines

Merged revisions 256900 via svnmerge from
https://origsvn.digium.com/svn/asterisk/branches/1.4

........
 r256900 | lmadsen | 2010-04-12 12:29:26 -0500 (Mon, 12 Apr 2010) | 15 lines
 
 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 ASTERISK-15935)
 Reported by: pabelanger
 Patches:
       HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
 Tested by: tzafrir, pabelanger, lmadsen
........

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256901
By: Digium Subversion (svnbot) 2010-04-12 12:30:33

Repository: asterisk
Revision: 256902

A   branches/1.6.2/doc/HOWTO_collect_debug_information.txt

------------------------------------------------------------------------
r256902 | lmadsen | 2010-04-12 12:30:32 -0500 (Mon, 12 Apr 2010) | 30 lines

Merged revisions 256901 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

................
 r256901 | lmadsen | 2010-04-12 12:29:53 -0500 (Mon, 12 Apr 2010) | 23 lines
 
 Merged revisions 256900 via svnmerge from
 https://origsvn.digium.com/svn/asterisk/branches/1.4
 
 ........
   r256900 | lmadsen | 2010-04-12 12:29:26 -0500 (Mon, 12 Apr 2010) | 15 lines
   
   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 ASTERISK-15935)
   Reported by: pabelanger
   Patches:
         HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
   Tested by: tzafrir, pabelanger, lmadsen
 ........
................

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256902
By: Digium Subversion (svnbot) 2010-04-12 12:31:02

Repository: asterisk
Revision: 256903

A   branches/1.6.1/doc/HOWTO_collect_debug_information.txt

------------------------------------------------------------------------
r256903 | lmadsen | 2010-04-12 12:31:02 -0500 (Mon, 12 Apr 2010) | 30 lines

Merged revisions 256901 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

................
 r256901 | lmadsen | 2010-04-12 12:29:53 -0500 (Mon, 12 Apr 2010) | 23 lines
 
 Merged revisions 256900 via svnmerge from
 https://origsvn.digium.com/svn/asterisk/branches/1.4
 
 ........
   r256900 | lmadsen | 2010-04-12 12:29:26 -0500 (Mon, 12 Apr 2010) | 15 lines
   
   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 ASTERISK-15935)
   Reported by: pabelanger
   Patches:
         HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
   Tested by: tzafrir, pabelanger, lmadsen
 ........
................

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256903
By: Digium Subversion (svnbot) 2010-04-12 12:31:34

Repository: asterisk
Revision: 256904

A   branches/1.6.0/doc/HOWTO_collect_debug_information.txt

------------------------------------------------------------------------
r256904 | lmadsen | 2010-04-12 12:31:34 -0500 (Mon, 12 Apr 2010) | 30 lines

Merged revisions 256901 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

................
 r256901 | lmadsen | 2010-04-12 12:29:53 -0500 (Mon, 12 Apr 2010) | 23 lines
 
 Merged revisions 256900 via svnmerge from
 https://origsvn.digium.com/svn/asterisk/branches/1.4
 
 ........
   r256900 | lmadsen | 2010-04-12 12:29:26 -0500 (Mon, 12 Apr 2010) | 15 lines
   
   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 ASTERISK-15935)
   Reported by: pabelanger
   Patches:
         HOWTO_collect_debug_information.txt.patch uploaded by lmadsen (license 10)
   Tested by: tzafrir, pabelanger, lmadsen
 ........
................

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=256904