Getting Started

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

1. Download

Use NuGet from Visual Studio to install your desired Glimpse packages. For ASP.NET MVC 5, install Glimpse Mvc5.

2. Enable

Run the app, navigate to /glimpse.axd and click Turn Glimpse On.

3. Using

Navigate around your site and start using Glimpse.

Download

Visual Studio & NuGet

Select from the Glimpse NuGet packages listed below. For detailed instructions see Step-by-step install guide for installing Glimpse.

Packages

Glimpse has many different extensions and plugins. Together with the community, there are some truly amazing extensions and extras you can install to analyze your app.

Select the packages to install

Which web framework you using?

WebForms  
PM> Install-Package Glimpse.WebForms
 
MVC  
PM> Install-Package Glimpse.MVC5

What about Data Access?

Raw ADO  
PM> Install-Package Glimpse.ADO
 
Entity Framework  
PM> Install-Package Glimpse.EF6

Note that if you are using a different version of MVC/EF, use that instead – that is, MVC2, MVC3, MVC4, EF43, or EF5. Many more packages can be found in the Glimpse Extension Gallery, and new packages are frequently added.

Enable

Glimpse is designed to be secure by default. This means that unless you tell Glimpse otherwise, you can only access Glimpse from localhost.

Note, this means that you won't be able to access Glimpse remotely with the default runtime policy. See Configuring runtime policy to enable Glimpse for remote access.

Navigate to /Glimpse.axd

Once Glimpse is installed, /Glimpse.axd (for example http://localhost:1234/glimpse.axd ) is exposed as an extension to your site. It becomes the point through which you can see how glimpse is configured and provides some helper buttons to work with Glimpse policies.

By clicking the "Turn Glimpse On" button, the page will confirm that Glimpse is now listening to requests.

Returning Home

Once "Turned on" you will see glimpse appear in the bottom right hand corner of your screen.

From this point, you can mouse over the various sections or open Glimpse up fully by clicking on the Glimpse icon. For more information, see Enabling Glimpse .

Using Glimpse

Once you’ve enabled Glimpse, the Glimpse Heads-Up Display (HUD) appears in the lower right corner of your web application.

Heads-Up Display (HUD)

The HUD is how Glimpse exposes information on every request, every page. This information is displayed at the bottom of your page.

It brings together information from both the client and server, to provide a complete picture of your request. This rich information can't be provided by browser tools. See Heads Up Display for more information.

Main Panel

From the HUD, you can dive down into another level of information by clicking on the "G" in the lower right corner. When the Main Panel opens you will be presented with a series of tabs which offer a range of insights into your application.

These tabs are easily selectable and your selected tab is remembered between redirects. Additional tabs will be added to your setup when you add additional packages. For more information see Tabs.

Observe

HUD updates its data as you move from page to page.

Detail

Hover over any one of the sections for more details.

Open

Click on the "G" icon on the right to open the Main Panel.

Switch

Select the various tabs you are interested in at any time.

Configuration

When Glimpse is installed via NuGet, a default configuration is added to a custom <glimpse> section  in the root web.config file. The default configuration works for many apps and you can modify the <glimpse> section to do things like black listing, removing tabs, changing security policy and more. For more information see Configuration.

Source Code

Want to download the latest source for Glimpse?

Latest source on GitHub

Whether you use NuGet or manually install Glimpse, the DLL's Glimpse needs to run will be referenced by your project and added to your bin folder. From here, for your first run, all you need is to enable Glimpse and start using it.

Additional Help

If you need more help, try the following resources:

  • Issue List - Found a problem? Report it on the GitHub Issue Tracker.
  • Mailing List - Creating a plugin or want to keep up with the latest Glimpse developments? Sign up for our Developers List.
  • Stack Overflow - Have a question? Ask away on StackOverflow, using the glimpse tag.
  • Blog - Want to keep up on the latest Glimpse news? Check out the blog.
  • Troubleshooting - Having trouble? See if our troubleshooting page can help.

More Information