Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.94 KB

README.textile

File metadata and controls

37 lines (25 loc) · 1.94 KB

HopSharp

HopSharp is a .NET library for use with the Hoptoad exception reporting service by Thoughtbot. Hoptoad allows you to easily track and get notification about exceptions that occur on your site.

The HopSharp library can be used in two forms. First, you can either programmatically report exceptions, if you have a try/catch block and want to ensure a particular exception is reported. And the second is through the use of an HttpModule, which will catch any unhandled exceptions on your site and report them.

Usage

To use the library, you’ll need to build the project and drop the HopSharp.dll and the Newtonsoft.Json.dll in your site’s bin directory. To configure the library, you’ll need to edit your web.config to include your API key for HopToad:

  <appSettings>
    <add key="Hoptoad:ApiKey" value="1234567890abcdefg"/>
  </appSettings>

To programmatically report exceptions, all you need to do is ensure you’ve included the “HopSharp” namespace, and then call the SendToHoptoad method on the exception. This is done using extension methods. For example:

  using HopSharp;
  ...
  try {
	// some code
  }
  catch(Exception ex) {
	// ohhnoes
	ex.SendToHopToad();
  }

To use the HttpModule, you will just need to add it as an HttpHandler within your web.config:

  <httpModules>
    <add name="Hoptoad" type="HopSharp.NotifierHttpModule, HopSharp"/>
  </httpModules>

TODO

There are some important things to do on the HttpModule still. Most importantly, it will be incredibly verbose on its exception handling. In .NET, a 404 is considered an exception, so it will catch, report, and subsequently notify you of any time someone tries to access a URL that doesn’t exist.

To circumvent this, plan on adding the ability to set a series of patterns that you can use to exclude exceptions based on exception type, part of the message, or something along those lines.