MailNews:Logging: Difference between revisions

 

 

* [[MailNews:Logging#gecko_logging|Gecko logging]], which uses case sensitive [[MailNews:Logging#Thunderbird_Module_Names|module names]], such as IMAP and IMAPAutoSync

 

 

This is the modern method, where logging is specified by [[MailNews:Logging#Setting_a_Preference|setting a preference]] in Thunderbird.

 

 

 

 

 

 

To configure logging via a Thunderbird Preference, you must create a hidden Thunderbird preference, not an environment variable. In Thunderbird :

 

Logging is permanent until you reset or delete a preference (by clicking the trash can).

 

 

You can view the output at Tools > Developer > Error Console. To expose timestamp, click the gear icon in top-right of the Error Console, turn on "Show Timestamps".

 

Thunderbird gets its module logging capabilities from Firefox core, also known as Gecko. Gecko logging capabilities are thoroughly documented in this [https://firefox-source-docs.mozilla.org/xpcom/logging.html excellent reference], including [https://searchfox.org/mozilla-central/search?q=LazyLogModule+.*%5C%28%22&path=&case=true&regexp=true module names].

# AbOutlookDirectory (before Thunderbird version 59: nsAbOutlookDirectoryLog)

* '''The current, full list of Thunderbird module names is seen in [https://searchfox.org/comm-central/search?q=LazyLogModule.*%5C%28&path=mailnews&case=false&regexp=true this searchfox query].'''

* Gecko modules potentially useful to Thunderbird users:  

** nsHostResolver (for DNS)

** nsSocketTransport (basic networking)

* Version 59 {{bug|1353919}} changed these options to be mixed case. The old, inconsistent case options are in parenthesis above.

'''NOTE - do not use this section for ldap, nntp, pop3 and smtp, which are configured per [[MailNews:Logging#Thunderbird_Logging|Thunderbird logging]].

Two variables must be set, '''MOZ_LOG''' and '''MOZ_LOG_FILE''' as local environment variables in a batch file/script (described [[MailNews:Logging#Generating_a_Gecko_Log|below]]) or on a command line. (using global system environment variables is not recommended)

==== MOZ_LOG_FILE ====

'''MOZ_LOG_FILE''' is the path and file name to the log file. An extension of '''.moz_log''' will be added to the file name (since Thunderbird 70). If MOZ_LOG_FILE is not set, then the output will be logged to the console/terminal (stdout) where the application was launched.

<code>set MOZ_LOG_FILE=thunderbird-log-file</code>

** Force logging to the console by setting MOZ_LOG_FILE to null, <code>MOZ_LOG_FILE=''</code>.

* A '''CASE SENSITIVE''' module name and its [[MailNews:Logging#Logging_Level|log level]], separated by a colon (:), such as '''example_module:5''' to enable the module example_module at logging level 5 (verbose).

* Optional special strings (switches) to configure the logging behaviour. Some configuration switches take an integer parameter, in which case the integer is separated from the string by a colon (:). Most switches only apply in a specific output context. Full documentation at [https://firefox-source-docs.mozilla.org/xpcom/logging.html#the-moz-log-syntax].

Example module and loglevel: '''"IMAP:4,IMAPAutoSync:5,timestamp"'''

''',timestamp''' adds a timestamp to all log lines - generally recommended, and required for all timeouts and issues which need to be correlated to an action at a given time of day

 

 

 

 

 

 

 

 

 

 

 

 

 

 

To generate an log, create a text file that contains the desired commands in a text editor such as BBEdit:  

  export MOZ_LOG=moduleName:5,timestamp

  export MOZ_LOG_FILE=$HOME/Desktop/log_file

  /Applications/Thunderbird.app/Contents/MacOS/thunderbird-bin &amp;

If on MacOS 10.5, change the last line to arch -arch i386 /Applications/Thunderbird.app/Contents/MacOS/thunderbird-bin &amp;

Save this file with a filename ending in .command, add execute permission by typing "<tt>chmod a+x ''filename''</tt>" in a Terminal window, then double-click it.  

Alternatively, you can setup a file so that the protocol tracing will always be in effect. (Not recommended if you use both Firefox and Thunderbird) To do this open a Terminal window, cd into the .MacOSX directory under your login directory and create a file named <tt>environment.plist</tt> containing the following. Non-unix users can use the "pico" editor which I think is available on OS X by default:<br>

<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;

&lt;plist version="1.0"&gt;

 

Variables set for MOZ_LOG and MOZ_LOG_file must be specified in quotation marks. MOZ_LOG_FILE must be fully specified without shortcuts, such as "~/". Run the following commands before running the application from the command line:

  export MOZ_LOG="moduleName:5,timestamp"

  export MOZ_LOG_FILE="/tmp/log_file"

  setenv MOZ_LOG moduleName:5,timestamp

  setenv MOZ_LOG_FILE /tmp/log_file

=== Missing Log File ===

* If logging ldap, nntp, pop3, or smtp, you '''must''' use [[MailNews:Logging#Thunderbird_Logging|Thunderbird logging]], not Gecko module logging using environment variables.

* If logging imap, you '''must''' use [[MailNews:Logging#Gecko_Logging|Gecko module logging]] using environment variables.

* If linux, variables MOZ_LOG and MOZ_LOG_file must be in quotation marks.

* If linux, MOZ_LOG_file must be fully specified without shortcuts, such as "~/"

* Did you restart your mailnews application, and wipe out the log of the session you wanted to debug?  (every restart wipes out the previous log)

* If you used a batch file on Windows, is the batch file set to run with administrator privileges?

== NSPR Logging Options ==

NSPR also has logging.  Miscellaneous [http://www.mozilla.org/projects/nspr/reference/html/prlog.html NSPR Reference (logging)].

Note that log module names are '''CASE SENSITIVE'''.