Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 2.84 KB

README.md

File metadata and controls

107 lines (70 loc) · 2.84 KB
Raw

RollbarSharp

.NET bindings for Rollbar.

This project is still under development and should be considered in a preview release state.

I'm not affiliated with Rollbar, I just like their service.

As of now this binding is only for .NET 4. If there's a widespread desire for .NET 2.0 support, I'd consider doing that. There's also a dependency on System.Web.Routing, so you'll at least need ASP.NET MVC installed on the system.

Installation

RollbarSharp is available on Nuget and can be installed by:

PM> Install-Package RollbarSharp

Usage

Configuration

The easiest way to get going is to add the Rollbar.AccessToken item to your app settings.

<configuration>
  <appSettings>
    <add key="Rollbar.AccessToken" value="YOUR_TOKEN_HERE"/>
    <add key="Rollbar.Environment" value="production"/>
  </appSettings>
</configuration>

As an ASP.NET Filter

public class RollbarExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext filterContext)
    {
        if (filterContext.ExceptionHandled)
            return;

        (new RollbarClient()).SendException(filterContext.Exception);
    }
}

And then in Global.asax.cs you can do

GlobalFilters.Filters.Add(new RollbarExceptionFilter());

Or if you're using an inversion of control system that supports binding filters, you could do it there. This is an example with Ninject. You could even dependency-inject the RollbarClient if you want to create it in your own factory method.

kernel.BindFilter<RollbarExceptionFilter>(FilterScope.Global, 10).InSingletonScope();

The OnException method could instead be used verbatim inside a Controller if you add the override keyword. protected override void OnException(ExceptionContext filterContext) ...

As an ASP.NET application event handler (Global.asax.cs)

protected void Application_Error(object sender, EventArgs e)
{
    var exception = (HttpException) Server.GetLastError();

    if (exception.InnerException == null)
        return;

    (new RollbarClient()).SendException(filterContext.Exception);
}

Bugs

  • If you encounter a bug, performance issue, or malfunction, please add an Issue with steps on how to reproduce the problem.

Building

I'm using Albacore for managing the build and bundling process. You'll need Ruby on your system to use it.

Installing the necessary gems (you only need to do this once):

gem install albacore version_bumper

Fetch nuget dependencies (from the build directory):

rake fetch_packages

And finally, building:

rake build

TODO

  • Add more tests
  • Test NLog extension
  • Create nuget package for the NLog extension