Documentation

Welcome to the Glimpse Documentation! Here we hope to introduce you to the various tutorials, concepts and APIs you might need when discovering and using Glimpse.

NOTE: Glimpse docs are currently being improved. If you'd like to help out, just edit this page or contribute to our GitHub Wiki

History Tab

The History tab lets you select a historical or remote HTTP request for Glimpse to display diagnostics information for.

History Tab

This tab allows you to view requests from not only your own browser, but from other devices in any location. This allows for several interesting use cases, including mobile debugging, remote client debugging, tracking workflows, etc.

Layout

  1. Client Session Panel: List of available client session's
  2. Client Request Panel: List of available client request's
  3. Client Name: Name given to the session that is being tracked by Glimpse
  4. Method: HTTP method used for the individual request (typically GET or POST)
  5. Request URL: URL that can be used identity individual requests
  6. Browser: Browser name that has been used for the request
  7. Data/Time: When the request was made
  8. Ajax: Whether the request was made via Ajax
  9. Launch: Opens a given request as the current context
  10. Count: Number of requests that are available to be viewed

Case study

Scenario

So your site works fine and is in production when you get a call from a user reporting a problem on a particular page. The same page works fine on your machine, but is buggy for them.

Glimpse has a feature which allows you to look at the "debug information" for page requests made by other users on other machines. This is also helpful if you are debugging a site in a mobile browser where the Glimpse client panel is not usable (i.e. a mobile device).

Setup

  • First you need to make sure that Glimpse is installed on the production site and turned on
    • To do this, you will want to ensure that the Local Policy is disabled so that Glimpse can be accessed
  • Next, you will want to flag their "session" as having Glimpse enabled in a read only capacity (meaning Glimpse will collect the information but they can't view it)
    • Typically this is done by setting a flag on their (perhaps in the user table or another like mechanism) and having a Custom Runtime Policy look for that flag
  • Once setup, we can now ask the user to load the problematic page again and you will be able to track their movements through the site as they replicate the problem

Tracking

When using the 'History' tab, you will note that the right hand side you should see a list of different clients and the number of request that were monitored by Glimpse. In the 'Client' column you should see the name that was specified by the user. Click on 'Launch' next to it to show the requests for the client.

The History tab behaves similar to the Ajax tab, you can 'Launch' one request to see the full data about that request. On the Request tab you can verify that the request was made by a History client machine. You can further review the information to find out what may have caused the problem.

It can also be helpful for local development. You can use different browsers to access your site and then compare the requests in one place.

Frequently Asked Questions

  • What happens when the maximum number of stored requests is reached (by default 25)?

    Internally we store the requests in a FIFO Queue. This means that when the maximum number spaces in the queue are filled, we take the first one that was entered and remove it from the queue, thus making room for the new request.