Changes between Version 12 and Version 13 of debugging


Ignore:
Timestamp:
07/03/11 17:50:56 (6 years ago)
Author:
octo
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • debugging

    v12 v13  
    1111  * You can find this out by packet sniffing the connection between your !BlackBerry, or a simulator, and your mail server. 
    1212  * You can also find this out by simulating the same commands !LogicMail uses, using something like telnet 
     13 
     14== Using the built-in logging == 
     15This feature works with from version 0.4 onward. 
     16On most BlackBerry devices, you can access the system event log by pressing '''Alt-lglg''' while on the home screen.  On the BlackBerry Storm, follow the instructions described [http://www.technipages.com/blackberry-storm-access-hidden-event-log-screen.html here].  If those don't work, Corey Gilmore wrote a very nice [http://coreygilmore.com/blog/2009/11/02/helper-application-to-view-the-event-log-on-a-blackberry-storm/ helper application] to bring up the event log. 
     17=== Configure the Event Logger === 
     18 * Press: Alt-lglg (the Event Log screen should appear) 
     19 * Go to the menu, and select "Options" 
     20 * Change the "Min log level" option to "Debug Info" 
     21 * Click the Menu button and select "Hide all types" to uncheck everything 
     22 * Now find and check the following items: 
     23   * '''Java Exception''' 
     24   * '''LogicMail''' 
     25   * '''net.rim.networkapi''' (if available) 
     26   * '''net.rim.tcp''' (if available) 
     27 * Return to the "Event Log" screen. 
     28 * Go to the menu, and select "Clear Log", and confirm. 
     29 * Return to the main BB screen 
     30 
     31=== Use LogicMail to reproduce the issue === 
     32 * Start !LogicMail 
     33 * Go to the menu, select "Configuration", scroll to the bottom, and enable "Connection debugging".  (''Note: Connection debugging only helps if the issue is a protocol error.  It won't be useful for connection problems.'') 
     34 * Now select your account, and do whatever caused the issue you were having. 
     35 * Once done, if you enabled connection debugging above, go back to the "Configuration" screen and disable "Connection debugging". 
     36 * Quit out of !LogicMail. 
     37 
     38=== Capture the log === 
     39 * Press: Alt-lglg 
     40 * Go to the menu, and select "Copy Day's Contents", and select "Filtered" 
     41 * Return to the BB main screen. 
     42 * Paste the log contents somewhere that you can access from off of your device.  There are a few options for this, but the most direct is a Task item: 
     43   * Go to "Tasks", create a new task, and paste the event log data into the "Notes" section at the bottom of the screen.  (surprisingly, this can hold a lot more text than a !MemoPad note.) 
     44   * Finally, sync this Task item to your PC, censor anything you don't want me to see (i.e., replace names and passwords with dummy characters), and either send the log to me, or attach it to a bug ticket. 
     45 
     46=== Notes on providing logs === 
     47 * When you censor the log text, please don't change the length or existence of special characters in the data.  Please leave in any and all spaces, punctuation, quotes, newlines, etc.  Any of these things could be the cause of the error, and if I cannot reproduce the issue by running pieces of !LogicMail on data in the log, I cannot fix it. 
     48 * Before sending me a log, '''''please''''' actually try to read it.  I make the logs quite verbose, and it should be obvious whether or not the log actually contains any sort of useful error message.  If the log just says the application started, loaded some local folders, then "Unable to open connection", the log ''probably does not actually contain any useful information''. 
     49 * When posting a log to this website, '''please''' use [wiki:WikiFormatting] so it is displayed correctly.  For a log dump, this usually means enclosing the log text like this: 
     50{{{ 
     51  {{{ 
     52  d LogicMail - MaildirFolder.open() 
     53  Opening: file:///SDCard/BlackBerry/logicmail/local/Drafts - 7/2 18:23:17 
     54  i LogicMail - Application startup 
     55  Date: Sat Jul 02 18:23:16 Europe/Brussels 2011 
     56  Name: LogicMail 
     57  Version: 2.0.0.282 
     58  Platform: 9700 5.0.0.586 
     59  - 7/2 18:23:16 
     60  }}} 
     61}}} 
    1362 
    1463== Capturing IMAP traffic == 
     
    56105 * The line ending with "EXISTS" shows you the number of messages in the mailbox. 
    57106 * The "FETCH" command contains the range of messages to retrieve information for.  In this case, its messages 19 through 20. 
    58  
    59 == Using the built-in logging == 
    60 This feature works with from version 0.4 onward. 
    61 On most BlackBerry devices, you can access the system event log by pressing '''Alt-lglg''' while on the home screen.  On the BlackBerry Storm, follow the instructions described [http://www.technipages.com/blackberry-storm-access-hidden-event-log-screen.html here].  If those don't work, Corey Gilmore wrote a very nice [http://coreygilmore.com/blog/2009/11/02/helper-application-to-view-the-event-log-on-a-blackberry-storm/ helper application] to bring up the event log. 
    62 === Configure the Event Logger === 
    63  * Press: Alt-lglg (the Event Log screen should appear) 
    64  * Go to the menu, and select "Options" 
    65  * Change the "Min log level" option to "Debug Info" 
    66  * Click the Menu button and select "Hide all types" to uncheck everything 
    67  * Now find and check the following items: 
    68    * '''Java Exception''' 
    69    * '''LogicMail''' 
    70    * '''net.rim.networkapi''' (if available) 
    71    * '''net.rim.tcp''' (if available) 
    72  * Return to the "Event Log" screen. 
    73  * Go to the menu, and select "Clear Log", and confirm. 
    74  * Return to the main BB screen 
    75  
    76 === Use LogicMail === 
    77  * Start !LogicMail 
    78  * Go to the menu, select "Configuration", scroll to the bottom, and enable "Connection debugging".  (''Note: Connection debugging only helps if the issue is a protocol error.  It won't be useful for connection problems.'') 
    79  * Now select your account, and do whatever caused the issue you were having. 
    80  * Once done, if you enabled connection debugging above, go back to the "Configuration" screen and disable "Connection debugging". 
    81  * Quit out of !LogicMail. 
    82  
    83 === Capture the log === 
    84  * Press: Alt-lglg 
    85  * Go to the menu, and select "Copy Day's Contents", and select "Filtered" 
    86  * Return to the BB main screen. 
    87  * Paste the log contents somewhere that you can access from off of your device.  There are a few options for this, but the most direct is a Task item: 
    88    * Go to "Tasks", create a new task, and paste the event log data into the "Notes" section at the bottom of the screen.  (surprisingly, this can hold a lot more text than a !MemoPad note.) 
    89    * Finally, sync this Task item to your PC, censor anything you don't want me to see (i.e., replace names and passwords with dummy characters), and either send the log to me, or attach it to a bug ticket. 
    90  
    91 === Notes on providing logs === 
    92  * When you censor the log text, please don't change the length or existence of special characters in the data.  Please leave in any and all spaces, punctuation, quotes, newlines, etc.  Any of these things could be the cause of the error, and if I cannot reproduce the issue by running pieces of !LogicMail on data in the log, I cannot fix it. 
    93  * Before sending me a log, '''''please''''' actually try to read it.  I make the logs quite verbose, and it should be obvious whether or not the log actually contains any sort of useful error message.  If the log just says the application started, loaded some local folders, then "Unable to open connection", the log ''probably does not actually contain any useful information''. 
    94  * When posting a log to this website, '''please''' use [wiki:WikiFormatting] so it is displayed correctly.  For a log dump, this usually means enclosing the log text like this: 
    95 {{{ 
    96   {{{ 
    97   d LogicMail - MaildirFolder.open() 
    98   Opening: file:///SDCard/BlackBerry/logicmail/local/Drafts - 7/2 18:23:17 
    99   i LogicMail - Application startup 
    100   Date: Sat Jul 02 18:23:16 Europe/Brussels 2011 
    101   Name: LogicMail 
    102   Version: 2.0.0.282 
    103   Platform: 9700 5.0.0.586 
    104   - 7/2 18:23:16 
    105   }}} 
    106 }}}