Sitecore Glimpse: How To Easily Get Advanced Debugging Information With No Dev Work!

If you have a Sitecore performance issue, or some other strange random bug, having the right debugging information can save you hours worth of frustration. If you’ve never come across Glimpse before, it’s a .NET package kind of like Chrome’s developer toolkit for CSS/Javascript, but for back-end server information. Glimpse provides runtime web diagnostics for websites showing you the inner workings of how your application works. When Glimpse is enabled, on each page request Glimpse gathers detailed diagnostic information and sends that data back to the client (your browser) as JSON.

A guy called Kevin Obee has extended Glimpse to include extra Sitecore specific data in its results, which make it a must have tool if you need to do any performance investigation, or troubleshooting within a Sitecore website. In today’s post, I’m going to cover how to install Sitecore Glass mapper and get up and running with it.

How To Install Sitecore.Glimpse?

Installing Glimpse for Sitecore is pretty easy as it’s simply adding two Nuget packages. In Visual Studio, right-click on your solution in ‘Solution Explorer’ and select ‘Manage Nuget Packages for Solution’.

sitecore_Glimpse_1

In Nuget, search for ‘Glass Mapper’ and install Glass.Mapper and Boc.Glass.Mapper.Sc.

Configuring Sitecore.Glimpse

You can enable Glimpse from your web browser by adding ‘Glimpse.axd’ to the end of your Sitecore instance Url, like so:

http://website.com/Glimpse.axd

When I first tried to access the Glimpse editor screen I got a 500.19 error, like so:

sitecore_Glimpse_3

This apparently is down to a web.config error. To fix this issue in your web.config do a search for trace. Delete that line and replace it with this one:

<trace writeToDiagnosticsTrace="true" enabled="true" requestLimit="50" pageOutput="false" traceMode="SortByTime" localOnly="true" />

Aftter this change if you try and load Glimpse again, it should load correctly and you should see:

sitecore_Glimpse_4

To enable Glimpse, hit the big ‘Turn Glimpse On’ button. Load your website, if everything has gone according to plan after your web page loads you should see a little button on the bottom left of the web page.

sitecore_Glimpse_2

If you click on the giant ‘G’ a chrome style developer toolkit will appear:

sitecore_glimpse_5

Most of the toolkit is standard out the box Glimpse feature. you should also see two Sitecore tabs:

  • Sitecore
  • Sitecore Analytics

Sitecore Tab

The Sitecore Tab contains information like the current Sitecore item, from here you can see all the properties that make up the page, the properties, and values for each property. Other information Sitecore Glimpse displays include what template has been used, license information, current user information, and IIS hosting details to name a few.

Sitecore Analytics

This tab displays information gathered by the Sitecore Experience Platform. If you don’t have Sitecore Experience Platform enabled then this tab will be disabled.

Jon D Jones

Software Architect, Programmer and Technologist Jon Jones is founder and CEO of London-based tech firm Digital Prompt. He has been working in the field for nearly a decade, specializing in new technologies and technical solution research in the web business. A passionate blogger by heart , speaker & consultant from England.. always on the hunt for the next challenge

More Posts

1 reply

Trackbacks & Pingbacks

  1. […] Glimpse provides runtime web diagnostics for websites showing you the inner workings of how your application works. When Glimpse is enabled, on each page request Glimpse gathers detailed diagnostic information and sends that data back to the client (your browser) as JSON. it’s a bit like (and looks like) Chromes developer toolkit that ships with Chrome. If you want to read more about Glimpse then I would recommend reading, Sitecore Glimpse: How To Easily Get Advanced Debugging Information With No Dev Work! […]

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply

Your email address will not be published. Required fields are marked *