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

Installing

Install Glimpse on each project you want to use it on (rather than once per server). The quickest way to get Glimpse up and running is by using one of the NuGet packages, but you can also install Glimpse manually.

Once you've installed Glimpse, you need to enable it on both the server and the client.

Prerequisites

  • ASP.NET applications using .NET 3.5 runtime or later
    • including ASP.NET Webforms and ASP.NET MVC
  • IIS 6+, IIS Express and Visual Studio's Web Development Server

Installing via NuGet

NuGet is a .NET package manager for Visual Studio 2010, 2012 and 2013. You can download the NuGet Visual Studio extension on the NuGet CodePlex site. For more information, see the NuGet docs.

Installing Glimpse with NuGet automatically updates web.config with the minimal configuration. See Configuration for details of how you can change the configuration.

Installing with the Manage NuGet Packages interface

In Visual Studio, in the Solution Explorer, right-click on your web project and select Manage NuGet Packages. Select the Online tab and enter Glimpse in the search bar.

NuGet Package Manager Interface

  • For an ASP.NET Webforms project, select the Glimpse.WebForms package and click Install.
  • For an ASP.NET MVC project, select Glimpse.Mvc4, Glimpse.Mvc3, or Glimpse.Mvc3 and click Install.

Note: The Glimpse Core (Glimpse) package contains the Glimpse framework infrastructure, and will be installed as part of the other Glimpse packages; you shouldn't install it on its own.

Installing with the Package Manager Console

In Visual Studio, open the View menu and select Other Windows -> Package Manager Console. Make sure your web project is the Default project.

  • For an ASP.NET Webforms project, enter Install-Package Glimpse.AspNet.
  • For an ASP.NET MVC project, enter Install-Package Glimpse.Mvc4, Install-Package Glimpse.Mvc3 or Install-Package Glimpse.Mvc2.

Installing manually

To install Glimpse manually, build the binaries, then update web.config.

Building Glimpse

  1. Download the latest .zip of the source code from GitHub.
  2. Extract the .zip file.
  3. From a command prompt, browse to the root of the extracted files and execute the command psake pack.
  4. In Windows Explorer, browse to {extracted root}/builds/local and locate Glimpse.zip. This file contains the assemblies required to build Glimpse.

Alternatively, you can get the Glimpse assemblies from the Glimpse NuGet Package.

Then, copy the Glimpse assemblies to your web application's libraries location, and add a project reference to them in Visual Studio.

Configuring Glimpse

If you installed Glimpse using NuGet, web.config should have been updated with the minimal configuration automatically, but you may want to check that this has happened correctly.

If you installed Glimpse manually, you’ll need to update web.config with the minimal configuration yourself. This involves adding a custom <section> and registering a HTTP module and HTTP handler.

See Configuration for details of how you can change the configuration from the minimal configuration.

Custom section

Add a custom <section> named glimpse to the <configSections> in web.config:

<configuration>
    <configSections>
        <section name="glimpse" type="Glimpse.Core.Configuration.Section, Glimpse.Core" />
    </configSections>
</configuration>

HTTP module and HTTP handler

Register a custom HTTP module and HTTP handler with ASP.NET, in the <system.web> section if you have IIS 6 or earlier, or in the <system.webServer> section for later versions of IIS.

For <system.web>:

<system.web>
    <httpModules>
        <add name="Glimpse" type="Glimpse.AspNet.HttpModule, Glimpse.AspNet"/>
    </httpModules>
    <httpHandlers>
        <add path="glimpse.axd" verb="GET" type="Glimpse.AspNet.HttpHandler, Glimpse.AspNet"/>
    </httpHandlers>
</system.web>

For <system.webServer>:

<system.webServer>
    <modules>
        <add name="Glimpse" type="Glimpse.AspNet.HttpModule, Glimpse.AspNet" preCondition="integratedMode"/>
    </modules>
    <handlers>
        <add name="Glimpse" path="glimpse.axd" verb="GET" type="Glimpse.AspNet.HttpHandler, Glimpse.AspNet"  preCondition="integratedMode" />
    </handlers>
</system.webServer>