Help

Omnibug is a browser extension that adds a new panel to your browser's developer tools to help debug web analytics & marketing pixels. This page will walk you through how to use Omnibug, as well as go over common issues and questions.

On this page:

  1. Installation
  2. Using Omnibug
  3. Settings
  4. FAQ
    1. Why isn't Omnibug showing any requests?
    2. Why do some requests show multiple times?
    3. Why don't you show when I navigated to a new page?
    4. Why do page view events show up as click events?
    5. Why isn't my provider listed?
    6. Why isn't Microsoft Edge supported?
    7. How can I report a bug or get more help?

Installation

To get started, Download or download for a different browser if you haven't already.

To verify that Omnibug installed correctly in Chrome, go to chrome://extensions/ in the URL bar (or from the Main menu » More Tools » Extensions) look for Omnibug. If you do not have Omnibug in the list, go back to the Chrome Webstore and try to re-add the extension (it should show up as "Added to Chrome" at the top right).

Chrome webstore's added to chrome button
On the Chrome Webstore, you should see this if Omnibug is installed.

Next, make sure that the checkbox next to "Enable" is checked. It is also suggested to check the checkbox "Allow in incognito" so that you can use Omnibug when viewing a page in incognito mode. When done correctly, it should look like the following screenshot.

Omnibug in the Chrome Extensions manager
Omnibug enabled & allowed in incognito

To verify that Omnibug installed correctly in Firefox, go to about:addons in the URL bar (or from the Main menu » Add-Ons) look for Omnibug. If you do not have Omnibug in the list, go back to the Firefox Add-Ons site and re-add it. Verify that it is set to enabled and does not have "(disabled)" next to Omnibug. If installed properly, it should look like the following screenshot.

Omnibug in the Firefox Add-Ons Manager
Omnibug enabled in the Add-Ons Manager

Using Omnibug

To use Omnibug, open your developer tools by hitting Ctrl Shift I, or for Chrome from the Main menu » More Tools » Developer Tools) for Firefox from the Main menu » Web Developer » Toggle Tools). This will open the browser's developer tools, where you can see the network requests, inspect elements on the page, or view the source code and cookies on the page. Navigate to the Omnibug tab within the developer tools.

With the developer tools open, navigate to a page you want to test. This page has marketing pixels installed (Google Analytics), so if you don't have any mind, try it on this page! Once you've navigated to the page, you should see requests coming in for the various marketing pixels and analytics tools that are installed on the page. If you don't, head to the FAQ section.

You can expand or collapse requests via the left arrow toggle. By default, all requests are collapsed, but expanding them will allow for you to see more detailed information about the request in a user-friendly fashion.

Google Analytics shown in Omnibug
A Google Analytics request show in in Omnibug
Google Analytics shown in Omnibug
A Google Analytics request show in in Omnibug

Along the top of the Omnibug panel, you can also clear all requests that are shown via the clear button (clear button).

Settings

There are a few settings options that are available.

To see your options, go to chrome://extensions/ in the URL bar (or from the Main menu » More Tools » Extensions) look for Omnibug. From there, click the "Options" link, which will open the settings page.

To see your options, go to about:addons in the URL bar (or from the Main menu » Add-Ons) look for Omnibug. From there, click the "Options" button, which will open the settings page.

There are a variety of settings you can customize:

Highlight parameter names
This allows you to specify URL parameters to highlight within the requests. This should be the raw parameter names, not the friendly names shown in the interface.
Enabled Providers
You can show or hide specific providers within the Omnibug panel. By default, all are selected.
Expand Entries
You can choose if you want all entries expanded or collapsed when they appear in the Omnibug panel. This is set to No by default.
Quote Values
You can choose if you want quotes around values, or if just the value should be showne. This is set to Yes by default.
Parameter display style
In the Omnibug panel, when a request is shown, you have the option to see the user-friendly description (e.g. "Page Title") or the raw parameter name (e.g. "dt="). By default "descriptions" is used.
Background colors
You can select what background color you want for each row for various events.

FAQ

Here are some common issues or questions we see:

Why isn't Omnibug showing any requests?

This can be caused by a few issues:

Why do some requests show multiple times?

This could be caused by a server-side redirect( e.g. a 302 or 307 redirect). Right now, you can tell if the request ID (the number to the right of the timestamp) is the same, then it can be considered a redirected request. We're working on a way to better show that a request is redirected.

Why don't you show when I navigated to a new page?

In order to support both Firefox and Chrome, we can't use the APIs that support this. We're investigating a workaround for this though. Stay tuned!

Why do page view events show up as click events?

Similar to the previous question, because of cross-browser support, we can't use the APIs that support telling us exactly when the page is completed. We're working on updating the providers to show based on if the provider says it was a page view or an event.

Why isn't my provider listed?

We're always looking to expand our providers! Visit our contributing page for more information on how you can help!

Why isn't Microsoft Edge supported?

As much as we want to support Internet Explorer and Microsoft Edge to allow a wider audience, the underlying APIs that Omnibug uses are still not supported. We'd love to see this change, but unfortunately it is out of our control.

How can I report a bug or get more help?

If you think you've found a bug or just need help, please submit a new issue on our GitHub page, or come chat with us on Discord.