Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / productivity / SharePoint

Visual Studio Integrated ULS Viewer (free Visual Studio 2012/2013 add-in)

0.00/5 (No votes)
5 Aug 2014CPOL3 min read 8.3K  
Visual Studio integrated ULS Viewer

Description

Visual Studio integrated ULS Viewer does not come to substitute or demand a place among the currently existing ULS viewers. Definitely, it cannot even be compared with the richness of functionality of the original UlsViewer from Microsoft (currently discontinued) but this is not the case as VS Integrated ULS Viewer was created with a totally different mindset and for totally different target group than the rest. VS Integrated ULS Viewer was not created for system admins or any other users that point to traditionally monitoring SharePoint activity. It was conceptualized for the average developer who feels comfortable inside Visual Studio and gets his time wasted by hopping around screens, windows and GUIDs to get his staff done.

tool.png

All icons belong to Icon8 set http://icons8.com from VisualPharm http://www.visualpharm.com.

Toolbar

803355/toolbar.PNG

In the top of the tool window lies one simplest toolbar consisting of the following options:

  1. Live mode, choose this to hook on the current log and poll for new entries
  2. Static mode, open an existing log file of your choice
  3. Information about number the currently filtered and fetched ULS traces
  4. Clear and dispose the items
  5. The currently processed log file

All buttons are interactive and come with 4 states noted by their border color:

  • Black: Inactive
  • Light Green: Active
  • Red: Error (Hover over the button and a tooltip relative to the error will give you a hint)
  • Orange: Currently processing

Filtering

803355/filtering.PNG

By clicking on the filtering expander, you will be offered with the following choices:

  1. Choose among the following categories: Message, Area, Category, Level and Correlation ID
  2. Choose among the following filtering options: Contains, Is equal to, Starts with, Ends with
  3. Enter the value you are looking for. The TextBox is providing search-as-you-type functionality.
  4. Go forth and back to previous filtering you have already made. My experience with Microsoft UlsViewer (besides that is a perfect tool) is that I was frustrated how I could (re)apply filters or remove them.
  5. Remove any filter
  6. Send maximum 50 of your filtered results to a colleague for his own consideration. It has been million times that an admin or another developer is trying to discuss with me a bug and it takes ages until I get all the related traces in my hand. No more ! Check.

ULS Traces

803355/listview.PNG

All the ULS traces fetched are presented in a ListView with the following format:

  1. Every item is a collapsed Expander, bringing to the user the minimum required information (timestamp and a summary of the message). If you want to see more, just expand the Expander.
  2. The message comes limited to a certain amount of characters, if you want to see the full message, click on the “More details” link that will be explained later.
  3. Filtering links. By clicking any of the links for Area, Category, Level or Correlation ID automatically, you apply a filter for this value.
  4. When the message is too long is been cropped. By clicking “More details” you get the full message and a little bit more…

803355/moredetails.PNG

  1. The full ULS trace.
  2. Send this message to a colleague.
  3. Search the web for this message or a part of it by selecting the text of your preference in the TextBox.

Every ULS trace that its level is one of the: Warning, Critical or Unexpected is adorned by a respective icon and alarm color like in the following pictures:

803355/warning.PNG

803355/critical.PNG

Hint: Press “End” button while having focus on your ListView and set it to autoscroll mode. Otherwise, it keeps visible the last selected item.

Related

For an even more enhanced SharePoint debugging experience, combine the Visual Studio ULS Viewer with our other tool Visual Studio SharePoint Debugging Assistant: https://spassistant.codeplex.com

Follow me on twitter for fun dev staff or related to our tools: https://twitter.com/akyriako78

Image 8 Image 9

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)