README.md

Bugsnag.NET

A .NET client for sending exception information to Bugsnag

Installation

Install-Package Bugsnag.NET

For PCLs

Install-Package Bugsnag.PCL

Usage

Some simple examples of how to use this client.

Configuration

Use the default IBugsnagger instance

This library provides a default IBugsnagger instance you can set some properties on to set up your integration.

Your setup might look something like this.

using System;
// ...
using Bugsnag.NET;
using Bugsnag.NET.Extensions;
using BsReq = Bugsnag.NET.Request;

// ...

    static void _InitBugsnag()
    {
        var snagger = Bugsnagger.Default;

        snagger.ApiKey = "YOUR_API_KEY_HERE";
        snagger.App = new BsReq.App
        {
            Version = "1.2.3",
            ReleaseStage = "test",
        };
    }

// ...

Bring your own IBugsnagger

Alternatively, you can choose to create your own IBugsnagger instance (or multiple), and hold references to it/them somewhere.

That might look something like this.

using System;
// ...
using Bugsnag.NET;
using Bugsnag.NET.Extensions;
using BsReq = Bugsnag.NET.Request;

// ...

    static IBugsnagger _Snagger { get; } = new Bugsnagger
    {
        ApiKey = "YOUR_API_KEY_HERE",
        App = new BsReq.App
        {
            Version = "1.2.3",
            ReleaseStage = "test",
        },
    };

// ...

Capture Errors

Depending on which approach you choose to take in your application, a simple setup to start sending application errors to Bugsnag might look like one of the following.

Default IBugsnagger instance

using System;
// ...
using Bugsnag.NET;
using Bugsnag.NET.Extensions;
using BsReq = Bugsnag.NET.Request;

class Program
{
    static void Main(string[] args)
    {
        _InitBugsnag();

        try
        {
            // Your app code here
        }
        catch (Exception ex)
        {
            _NotifyBugsnag(ex);

            throw;
        }
    }

    static void _InitBugsnag()
    {
        var snagger = Bugsnagger.Default;

        snagger.ApiKey = "YOUR_API_KEY_HERE";
        snagger.App = new BsReq.App
        {
            Version = "1.2.3",
            ReleaseStage = "test",
        };
    }

    static void _NotifyBugsnag(Exception ex)
    {
        Bugsnagger.Default.Error(ex, _GetUser(), _GetMetadata());
    }

    static BsReq.IUser _GetUser() { /* ... */ }

    static object _GetMetadata() { /* See Metadata section */ }
}

Custom IBugsnagger instance

using System;
// ...
using Bugsnag.NET;
using Bugsnag.NET.Extensions;
using BsReq = Bugsnag.NET.Request;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // Your app code here
        }
        catch (Exception ex)
        {
            _Snagger.Error(ex, _GetUser(), _GetMetadata());

            throw;
        }
    }

    static IBugsnagger _Snagger { get; } = new Bugsnagger
    {
        ApiKey = "YOUR_API_KEY_HERE",
        App = new BsReq.App
        {
            Version = "1.2.3",
            ReleaseStage = "test"
        },
    };

    static void _NotifyBugsnag(Exception ex)
    {
        var snagEvent = _Snagger.CreateEvent(
            BsReq.Severity.Error,
            ex,
            _GetUser(),
            _GetMetadata());

        _Snagger.Notify(snagEvent);
    }

    static BsReq.IUser _GetUser() { /* ... */ }

    static object _GetMetadata() { /* See Metadata section */ }
}

Metadata

Metadata can be passed in as anonymous types, as Bugsnag expects key/value pairs for these.

For example, the following will create two extra tabs in Bugnsag's online interface which will have the labels "firstTab" and "secondTab", respectively:

object GetMetadata() {
{
    return new
    {
        firstTab = new
        {
            someKey = "some value",
        },
        secondTab = new
        {
            anotherKey = "another value",
        },
    };
}

For keys/values at the root level of this metadata object, Bugsnag creates a tab for you with the label "Custom", and displays them there. That case would look like this:

object GetMetadata() {
    return new
    {
        keyUnderCustomTab = "some value",
        anotherKeyUnderCustomTab = "another value",
    }
}