remote/doc/Debugging.md

   1 Debugging
   2 =========
   3
   4 For other debugging resources, see also: Remote project [wiki]
   5
   6 Increasing the logging verbosity
   7 --------------------------------
   8
   9 To increase the internal logging verbosity you can use the
  10 `remote.log.level` [preference].
  11
  12 If you use mach to start Firefox:
  13
  14         ./mach run --setpref "remote.log.level=Trace" --remote-debugging-port
  15
  16 By default, long log lines are truncated. To print long lines in full, you
  17 can set `remote.log.truncate` to false.
  18
  19 Enabling logging of emitted events
  20 ----------------------------------
  21
  22 To dump events produced by EventEmitter,
  23 including CDP events produced by the Remote Agent,
  24 you can use the `toolkit.dump.emit` [preference]:
  25
  26   ./mach run --setpref "toolkit.dump.emit=true" --remote-debugging-port
  27
  28
  29 Logging observer notifications
  30 ------------------------------
  31
  32 Observer notifications are used extensively throughout the
  33 code and it can sometimes be useful to log these to see what is
  34 available and when they are fired.
  35
  36 The `MOZ_LOG` environment variable controls the C++ logs and takes
  37 the name of the subsystem along with a verbosity setting.  See
  38 [prlog.h] for more details.
  39
  40         MOZ_LOG=ObserverService:5
  41
  42 You can optionally redirect logs away from stdout to a file:
  43
  44         MOZ_LOG_FILE=service.log
  45
  46 This enables `LogLevel::Debug` level information and places all
  47 output in the file service.log in your current working directory.
  48
  49
  50 [preference]: Prefs.md
  51 [System observer notifications]: https://developer.mozilla.org/en-US/docs/Archive/Add-ons/Overlay_Extensions/XUL_School/Observer_Notifications
  52 [prlog.h]: https://searchfox.org/mozilla-central/source/nsprpub/pr/include/prlog.h
  53 [wiki]: https://wiki.mozilla.org/Remote/Developer_Resources