Omnibug, a tool for web metrics debugging

Omnibug is a plugin for Firebug to ease developing web metrics implementations. Each outgoing request (sent by the browser) is checked for a pattern; if a match occurs, the URL is displayed in a Firebug panel, and decoded to show the details of the request. In addition, requests can be logged to the filesystem.

Out of the "box", it supports Omniture, WebTrends, Google Analytics/Urchin and Moniforce. Custom matching rules can be defined to support other systems.

Get It

Download/Install: omnibug-0.5.394.xpi, released 2010-07-16 00:56:02

Changes:

New: Key descriptions

The major new feature for this release is the addition of description tooltips on keys. These are currently only available for SiteCatalyst and Google Analytics (please contact me if you have these details for other analytics implementations). In addition, the old behavior of resetting the default pattern on startup has been removed. It now behaves like any other preference (including being observed for changes, which take effect immediately).

Twitter

Omnibug has a Twitter account, where I'll tweet new releases and news. Feel free to follow @omnibug!

Preferences

Pref name Default value Description
extensions.omnibug.defaultPattern /b/ss/|2o7|moniforce\.gif|dcs\.gif|__utm\.gif This is the default regular expression to check URLs against.
extensions.omnibug.userPattern [not set] If defined, requests will also be checked against this expression. It should be used to add additional patterns.
extensions.omnibug.enableFileLogging false If true, requests will also be logged to a file (see logFileName). Can also be set in the UI via the Options menu
extensions.omnibug.logFileName [not set] If enableFileLogging is true, requests will be logged to this file. Can also be set in the UI via the Tools -> Choose log file menu entry
extensions.omnibug.usefulKeys pageName,ch,h1,purchaseID,events,products,pev2 Comma-separated list of key names that are grouped under the 'Useful' section (see screenshot)
extensions.omnibug.highlightKeys events,products Comma-separated list of key names that are highlighted with a background color (see color_hilite). This list can contain keys from any section.
extensions.omnibug.watchKeys [not set] Comma-separated list of key names that are active in the 'Watches' side panel. This list can contain keys from any section.
extensions.omnibug.alwaysExpand false If true, show entries on the Omnibug tab as expanded; otherwise shown as collapsed
extensions.omnibug.showQuotes true If true, surround values with quote marks; otherwise don't surround.
extensions.omnibug.color_load #dbedffExample Background color for load events
extensions.omnibug.color_click #f1ffdbExample Background color for click events
extensions.omnibug.color_prev #ffd5deExample Background color for events generated on the previous page
extensions.omnibug.color_quotes #f00Example Color for quotes surrounding values (see showQuotes)
extensions.omnibug.color_hilite #ff0Example Background color for highlight (see highlightKeys)
extensions.omnibug.color_hover #cccExample Background color for row hover

A preferences screen is available ("Prefs", on the top of the panel, to the right of the Firebug icon). Preferences can be changed there, via the "about:config" interface in Firefox, or by adding entries to user.js/prefs.js. Changes to preferences take effect immediately.

Log file

The log file consists of four fields delimited by tabs: date, md5 sum of metrics URL, metrics URL and originating URL.

Sun Jan 18 2009 14:15:35 GMT+0100 (CET) b01eaf09e85ce7debb76e0d8aff16175 http://www.google-analytics.com/__utm.gif?utmwv=4.3&utmn=1379150988&utmhn=www.guidespot.com&utmcs=UTF-8&utmsr=1440x900&utmsc=24-bit&utmul=en-us&utmje=1&utmfl=10.0%20r12&utmdt=Guidespot.com&utmhid=444972883&utmr=-&utmp=/&utmac=UA-2418780-2&utmcc=__utma%3D169863095.2617619934608929300.1232283578.1232283578.1232284535.2%3B%2B__utmz%3D169863095.1232283578.1.1.utmcsr%3D(direct)%7Cutmccn%3D(direct)%7Cutmcmd%3D(none)%3B http://www.guidespot.com/

Compatibility

Screenshot (click to enlarge)

Omnibug screenshot

Previous Versions

Support

To report a bug, request a feature, or for general comments and questions, feel free to email me. I don't guarantee an answer, but I'll try.

Donation

If you find Omnibug useful, feel free to make a donation (via PayPal) by clicking on the button below. There is no obligation, of course.

Legal

Omnibug is distributed under version 1.1 of the Mozilla Public License.

Firefox, Firebug, Omniture/SiteCatalyst, WebTrends, Google Analytics, Urchin, Moniforce and Guidespot.com are the property of their respective owners.

 

Modified Friday, 16-Jul-2010 00:58:59 CDT