Honeybadger.Extensions.Logging 0.3.0

Honeybadger for .Net Apps

This is the .Net Honeybadger Notifier.

Supported .Net versions:

Getting Started

For .Net Core Web App

1. Install Honeybadger.DotNetCore from Nuget

dotnet add package Honeybadger.DotNetCore

2. Register the Honeybadger Middleware:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHoneybadger();

You can get access to the Honeybadger Client using DI:

app.MapGet("/", ([FromServices] IHoneybadgerClient client) =>
{
    client.AddBreadcrumb("reached index route", "route", new Dictionary<string, object?>());
    
    return "Hello World!";
});

2. Any unhandled exceptions should be reported to Honeybadger automatically:

app.MapGet("/debug", () =>
{
    throw new Exception("hello from .Net Core Web App!");
});

See example project in examples/Honeybadger.DotNetCoreWebApp.

As a custom logging provider

1. Install Honeybadger.Extensions.Logging from Nuget

dotnet add package Honeybadger.Extensions.Logging

2. Register the custom logging provider:

var builder = WebApplication.CreateBuilder(args);
builder.Logging.AddHoneybadger();

3. Errors from the logger will be reported to Honeybadger:

app.MapGet("/notify", ([FromServices] ILogger logger) =>
{
    logger.LogError("hello from Honeybadger.Logger!");
    
    return "Log reported to Honeybadger. Check your dashboard!";
});

See example project in examples/Honeybadger.DotNetCoreWebApp.Logger.

Using the SDK manually

1. Install the Honeybadger Nuget.

dotnet add package Honeybadger

2. Initialize the Honeybadger Client:

var client = HoneybadgerSdk.Init(new HoneybadgerOptions("apiKey")
{
    AppEnvironment = "development"
});

3. Call notify to report to Honeybadger:

client.Notify("hello from .Net !");

See example project in examples/Honeybadger.Console.

Changelog

Changelog is automatically generated using Conventional Commits with versionize. Conventional Commits are enforced with a pre-commit git hook (using husky).

Contributing

1. Fork the repo.
2. Create a topic branch git checkout -b my_branch
3. Commit your changes git commit -am "chore: boom"
4. Write a test that verifies your changes
5. Push to your branch git push origin my_branch
6. Send a pull request
7. Make sure that CI checks are passing

Releasing

All packages are published on nuget.org with a Github Actions Worfklow. The workflow does the following:

• dotnet versionize - bump versions and generate changelog
• dotnet pack
• dotnet package push

Note: only users with write permissions can trigger this workflow (i.e. Collaborators).

Known bugs

• Always shows "Honeybadger.HoneybadgerClient" when reporting a notice with a message

TODO

• Publish README with basic info to setup core nuget
• Publish Honeybadger.DotNetCore with README
• Publish Honeybadger.Extensions.Logging with README
• Deploy under Honeybadger org
• Implement Error Grouping (custom fingerprint)
• Implement Error Tags
• Allow excluding errors (either with a BeforeNotify method or exception classes config)
• Implement Filter Keys (exclude sensitive keys)
• Implement Checkins
• Implement Collect User Feedback
• Create guide for Deployment Tracking
• Create integration guide in honeybadger-docs project

License

This Honeybadger repository and published packages are MIT licensed. See the MIT-LICENSE file in this repository for details.