Loop/Debugging: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (Standard8 moved page Loop/Logging to Loop/Debugging)
(Add debugging information)
Line 1: Line 1:
If your call connection fails in some way (during set-up, or during the call), here's what we need to know:
== Debugging Loop ==


* OS & Firefox version at both ends of the call
There are some options/preferences that will help with debugging issues with Loop. We are working on exposing more of the failures via the UI, but these are likely to continue to be useful, especially for developers.
* Date and Time of the call
* Any Console Errors/Warnings:
** If you're using the pop-up window (receiving a call), then open the Browser Console (under Developer in the Application menu). ''As this is the console for the whole browser, there may be unrelated errors & warnings in here, but if in doubt as to what is related, include as much as possible''.
** If you're using the website (initiating a call after clicking on the link), then open the Web Console (under Developer in the Application menu).
* about:webrtc information
** Visit about:webrtc in a new tab, at the bottom press "Connection Log"
** Copy & paste the information to a new file & attach to bug.


If call setup worked, but you have audio/video issues during the call then additionally and before stopping the call:
=== Current Preferences ===


* Visit about:webrtc
* <code>debug.websocket</code> (true/false)
** At the bottom, press "Start Debug Mode"
** This enables debug for the connection activity between client and server when connecting a direct call, or an original call-url based call.
** After a few seconds, select "Stop Debug Mode"
** This shows information as to what stage the connections have got to, and reasons as to why calls may have been rejected.
* A file is saved into your temp directory
* <code>debug.sdk</code> (true/false)
** On Mac it is <code>/tmp/WebRTC.log</code>
** Turns on debugging of the [https://tokbox.com/opentok/libraries/client/js/ OpenTok sdk]
* Copy the saved debug file and keep it safe, in case it is needed to be analyzed (it is quite big, so if sending/uploading it, you may want to zip the file first.
** This is most useful for debugging if issues are occurring within the sdk, e.g. video/audio setup issues.
* <code>debug.dispatcher</code> (true/false)
** This logs "actions" that are generated in the UI.
** These are to aid developer diagnostics of the flow of information around the flux-based system.
** Currently only the direct calling outgoing window uses flux.
* <code>debug.loglevel</code>
**
 
=== How to turn on debugging ===
 
==== Firefox Desktop ====
 
Go into <code>about:config</code> and search for the preference, prefixed by <code>loop.</code>. Then set the value to appropriately.
 
For example, for <code>debug.websocket</code>, set the preference <code>loop.debug.websocket</code> to true.
 
Debug output is shown on the Browser Console (not the web console), accessible from the Tools -> Web Developer menu.
 
==== Link Clicker UI ====
 
This is the standalone UI, shown when clicking a link. To turn on debugging:
 
* Open the Web Console (accessible from the Tools -> Web Developer Menu)
* In the line at the bottom, (with the '>' symbol) enter:
 
localStorage.setItem("debug.websocket", true);
 
* (or use the values appropriate to the pref you want to set.
* Debug output will then appear on the webconsole.
* The preference value will stay set, until you clear the site's local storage or manually enter:
 
localStorage.removeItem("debug.websocket");


===Logging Bugs===
===Logging Bugs===
Please log bugs in bugzilla under 'Loop' Product:
Please log bugs in bugzilla under 'Loop' Product:
* https://bugzilla.mozilla.org/enter_bug.cgi?product=Loop
* https://bugzilla.mozilla.org/enter_bug.cgi?product=Loop

Revision as of 08:41, 6 October 2014

Debugging Loop

There are some options/preferences that will help with debugging issues with Loop. We are working on exposing more of the failures via the UI, but these are likely to continue to be useful, especially for developers.

Current Preferences

  • debug.websocket (true/false)
    • This enables debug for the connection activity between client and server when connecting a direct call, or an original call-url based call.
    • This shows information as to what stage the connections have got to, and reasons as to why calls may have been rejected.
  • debug.sdk (true/false)
    • Turns on debugging of the OpenTok sdk
    • This is most useful for debugging if issues are occurring within the sdk, e.g. video/audio setup issues.
  • debug.dispatcher (true/false)
    • This logs "actions" that are generated in the UI.
    • These are to aid developer diagnostics of the flow of information around the flux-based system.
    • Currently only the direct calling outgoing window uses flux.
  • debug.loglevel

How to turn on debugging

Firefox Desktop

Go into about:config and search for the preference, prefixed by loop.. Then set the value to appropriately.

For example, for debug.websocket, set the preference loop.debug.websocket to true.

Debug output is shown on the Browser Console (not the web console), accessible from the Tools -> Web Developer menu.

Link Clicker UI

This is the standalone UI, shown when clicking a link. To turn on debugging:

  • Open the Web Console (accessible from the Tools -> Web Developer Menu)
  • In the line at the bottom, (with the '>' symbol) enter:
localStorage.setItem("debug.websocket", true);
  • (or use the values appropriate to the pref you want to set.
  • Debug output will then appear on the webconsole.
  • The preference value will stay set, until you clear the site's local storage or manually enter:
localStorage.removeItem("debug.websocket");

Logging Bugs

Please log bugs in bugzilla under 'Loop' Product:

Retrieved from "https://wiki.allizom.org/index.php?title=Loop/Debugging&oldid=1022384"