Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-23 21:01:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bug 1596729: remote: document ObserverService logging

Browse Source 
DONTBUILD

Differential Revision: https://phabricator.services.mozilla.com/D53179

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Andreas Tolfsen 2019-11-15 13:42:22 +00:00
parent 9d40766fe5
commit 615400cd7a
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
remote/doc/Debugging.md
View File

@ -1,6 +1,7 @@
Debugging
=========
Increasing the logging verbosity
--------------------------------
@ -11,6 +12,7 @@ If you use mach to start Firefox:
./mach run --setpref "remote.enabled=true" --setpref "remote.log.level=Debug" --remote-debugger
Enabling logging of emitted events
----------------------------------
@ -20,4 +22,28 @@ you can use the `toolkit.dump.emit` [preference]:
./mach run --setpref "remote.enabled=true" --setpref "toolkit.dump.emit=true" --remote-debugger
Logging observer notifications
------------------------------
[System observer notifications] are used extensively throughout the
code and it can sometimes be useful to log these to see what is
available and when they are fired.
The `MOZ_LOG` environment variable controls the C++ logs and takes
the name of the subsystem along with a verbosity setting. See
[prlog.h] for more details.
MOZ_LOG=ObserverService:5
You can optionally redirect logs away from stdout to a file:
MOZ_LOG_FILE=service.log
This enables `LogLevel::Debug` level information and places all
output in the file service.log in your current working directory.
[preference]: ./Prefs.html
[System observer notifications]: https://developer.mozilla.org/en-US/docs/Archive/Add-ons/Overlay_Extensions/XUL_School/Observer_Notifications
[prlog.h]: https://searchfox.org/mozilla-central/source/nsprpub/pr/include/prlog.h