additional checking related to issue 17186
[asterisk/asterisk.git] / doc / HOWTO_collect_debug_information.txt
1 ===============================================================================
2 ===
3 === HowTo: Collect Debug Information for the Asterisk Issue Tracker
4 ===
5 === Written by: Paul Belanger
6 === Last updated: 2010-04-12
7 ===============================================================================
8
9 This document will provide instructions on how to collect debugging logs from an
10 Asterisk machine, for the purpose of helping bug marshals troubleshoot an issue
11 on https://issues.asterisk.org
12 -------------------------------------------------------------------------------
13 --- PREREQUISITES
14 -------------------------------------------------------------------------------
15
16 - Asterisk 1.4.30 or greater.
17
18 -------------------------------------------------------------------------------
19 --- STEPS
20 -------------------------------------------------------------------------------
21
22 1. Edit the logger.conf file to enable debug output to your filesystem.
23
24    Add the following line. The word "myDebugLog" can be changed to anything you
25    want, as that is the filename the logging will be written to. A good example
26    might be something like: issue_12345_full_log
27
28    myDebugLog => notice,warning,error,debug,verbose,dtmf
29
30 2. From the Asterisk CLI, restart the logger module:
31
32    *CLI> core set verbose 15
33    *CLI> core set debug 15
34    *CLI> module reload logger
35
36    Optionally, if you've used this file to record data previously, then rotate
37    the logs:
38
39    *CLI> logger rotate
40
41 2.1. Depending on your issue, be sure to enable the channel driver logging.
42
43      SIP (1.6.0 or higher)
44
45         *ClI> sip set debug on
46
47      SIP (1.4)
48
49         *CLI> sip set debug
50
51      IAX2 (1.6.0 or higher)
52
53         *CLI> iax2 set debug on
54
55      IAX2 (1.4)
56
57         *CLI> iax2 set debug
58
59 3. Reproduce your issue.
60
61 4. Once finished, be sure to disable the extra debbuging:
62
63    *CLI> core set verbose 0
64    *CLI> core set debug 0
65
66 4.1. Again, remember to disable any extra logging if you enabled it in the
67      channel driver.
68
69      SIP (1.4 or higher)
70
71         *ClI> sip set debug off
72
73      IAX2 (1.4 or higher)
74
75         *CLI> iax2 set debug off
76
77 5. Upload the file located in /var/log/asterisk/myDebugLog to the issue tracker.
78
79    *** IMPORTANT ***
80    Do NOT post the output of your file as a comment. This clutters the issue
81    and will only result in your comment being deleted.
82
83 6. Disable logging to the filesystem. Edit the logger.conf file and comment out
84    or delete the line you added in step 1. Using a semi-colon as the first
85    character on the line will comment out the line.
86
87    Then reload the logger module like in step 2:
88
89    *CLI> module reload logger