Gaia/Email/RequiredBugInfo: Difference between revisions

Jump to navigation Jump to search

Gaia/Email/RequiredBugInfo (view source)

Revision as of 11:48, 20 February 2015

612 bytes added ,  20 February 2015
Correct MDN link that was long-dead and provide better windows guidance
No edit summary
(Correct MDN link that was long-dead and provide better windows guidance)
Line 19: Line 19:
** Have the "adb" command available and usable.  If you can type "adb logcat" with the device plugged in and see some junk show up (especially "LOG: Mail universe/bridge created, notifying" when you start the e-mail app from when it was closed), then it's working!  No adb?  Not working? then:
** Have the "adb" command available and usable.  If you can type "adb logcat" with the device plugged in and see some junk show up (especially "LOG: Mail universe/bridge created, notifying" when you start the e-mail app from when it was closed), then it's working!  No adb?  Not working? then:
*** no adb?  [https://developer.mozilla.org/en-US/Firefox_OS/Firefox_OS_build_prerequisites#Install_adb install adb]
*** no adb?  [https://developer.mozilla.org/en-US/Firefox_OS/Firefox_OS_build_prerequisites#Install_adb install adb]
*** adb doesn't seem to see the device? [https://developer.mozilla.org/en-US/Firefox_OS/Firefox_OS_build_prerequisites#For_Linux.3A_configure_the_udev_rule_for_your_phone enable the permissions in udev rules]
*** adb doesn't seem to see the device and you're using linux and you've checked all the bullet points below? [https://developer.mozilla.org/en-US/Firefox_OS/Firefox_OS_build_prerequisites#For_Linux.3A_configure_the_udev_rule_for_your_phone enable the permissions in udev rules]
** Second: make sure the logcat stays connected even when the screen locks / the display turns off. You have to have both:
** Second: turn on "adb" support on your device and make sure the logcat stays connected even when the screen locks / the display turns off.
*** [https://developer.mozilla.org/en-US/Firefox_OS/Firefox_OS_usage_tips/Remote_debugging "remote debugging" enabled] (which is what makes logcat work at all) from the settings app
*** See https://developer.mozilla.org/en-US/docs/Tools/WebIDE#Connecting_a_Firefox_OS_device which mentions how to go to the settings UI and enable "Remote Debugging" from the "Developer" menu and disabling the screen lock from the "Screen Lock" menu.
*** you need to disable the lock screen in order for logcat to remain connected.
** Capture the logcat!
*** (There are other ways to make this happen, but they are technical and I don't know them.  Feel free to edit the wiki and include instructions here.)
*** It is very important that you capture the logcat to a file and that you start the capture process before reproducing the bug.  (logcat uses a circular buffer that discards older entries when the buffer fills up, so if you run logcat only after the problem happens, you may not have all of the logic.)
** Please provide the logcat by running '''adb logcat -v time -s GeckoDump:V Gecko:V GeckoConsole:V OomLogger:V | tee FILENAME-TO-LOG-TO'''.  Please start running this command BEFORE you attempt to reproduce the problem.  logcat uses a circular buffer that discards older entries when the buffer fills up, so if you run logcat only after the problem happens, you may not have all of the logic. Once you are done, hit control-C and send us the file.  
*** Running logcat:
**** Want to see the log as it happens and you are using linux or OS X?
***** Run '''adb logcat -v time -s GeckoDump:V Gecko:V GeckoConsole:V OomLogger:V | tee FILENAME-TO-LOG-TO'''.  Please start running this command BEFORE you attempt to reproduce the problem.   Once you are done, hit control-C and send us the file.
**** Using windows or that gave you an error about the command "tee" not existing? Use file redirection:
***** Run '''adb logcat -v time -s GeckoDump:V Gecko:V GeckoConsole:V OomLogger:V > FILENAME-TO-LOG-TO'''.  Please start running this command BEFORE you attempt to reproduce the problem.   Once you are done, hit control-C and send us the file.
*** (What did all those cool flags do?)
**** The logcat arguments filter out a lot of the noise that we don't care about and gives us timestamps.
**** The logcat arguments filter out a lot of the noise that we don't care about and gives us timestamps.
**** The "tee" command lets you see the output while also logging the output directly to a file.  This way you don't have to copy and paste the log.
**** The "tee" command lets you see the output while also logging the output directly to a file.  This way you don't have to copy and paste the log.
**** Also, please only include portions of the log from the e-mail app; searching for "LOG: Mail universe/bridge created" is a good way to find out when the e-mail app started.  Apparently, other apps are much more likely to reveal private data, and we do not want any of that.  We do try to avoid doing that, but please also skim the contents of the log to make sure there are no obvious reveals of personal information.  Currently, we expect the e-mail domain you are signing up for to be exposed in the log if your problem occurs during the configuration process, but we really need that info anyways.
*** Make sure the log file does not include any private information / redact any private information
**** The email app tries hard to avoid including private information, but the log may contain activity from other apps.  Specifically, the email app may include:
***** Your email address (if creating a new account)
***** The domain of the mail server you use (anytime we connect to a server, and especially during creating a new account)
**** It's okay to edit the file, including using search-and-replace to change domain names or stuff like that.  If you remove some lines entirely, it can be helpful to make sure you tell us that, possibly by writing in the log what was removed.
* Secret debug:  For now, logcats are usually still good enough, but if we request or you would like to provide the more detailed structured logging output, please see https://wiki.mozilla.org/Gaia/Email/SecretDebugMode
* Secret debug:  For now, logcats are usually still good enough, but if we request or you would like to provide the more detailed structured logging output, please see https://wiki.mozilla.org/Gaia/Email/SecretDebugMode
; If the problem involves a specific message and the problem is not duplicated for other messages, it would be great if you could look at the message in an alternate mail client: (like webmail or Thunderbird) and see if the message has anything special about it.  If you can't tell and the message is not private, attaching a copy of the message to the bug can be very helpful.
; If the problem involves a specific message and the problem is not duplicated for other messages, it would be great if you could look at the message in an alternate mail client: (like webmail or Thunderbird) and see if the message has anything special about it.  If you can't tell and the message is not private, attaching a copy of the message to the bug can be very helpful.
Andrew Sutherland
Confirmed users
360

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/1057161"

Navigation menu