Sharpbrake.Serilog

A Serilog sink that sends log records to Airbrake.

Airbrake sink

In the example shown, the sink will send logs to Airbrake with a minimum log level of LogEventLevel.Fatal. The Sharpbrake.Serilog Sink also supports more flexible Airbrake customization using the AirbrakeConfig class.

Log.Logger = new LoggerConfiguration()
    .WriteTo.Airbrake(projectId: "<projectId>", projectKey: "<projectKey>", LogEventLevel.Fatal)
    .CreateLogger();

StackTraceCapturer sink

This sink allows you to use stack capturing when it's needed, for example when you want to use Async sink while keeping the original stack trace. This is how you use it:

var config = new Sharpbrake.Client.AirbrakeConfig
{...};
 
var config = new LoggerConfiguration()
    .WriteTo
    .StackTraceCapturer(w => w.Async(x => x.Airbrake(config, LogEventLevel.Fatal)));

Log.Logger = config.CreateLogger();

In the code above the StackTraceCapturer is added and it wraps other sink - Async which in turn wraps our Airbrake sink described above - this way you can notify Airbrake in an async manner while keeping the original stack traces.

Additional filtering

You can specify additional filtering for the Airbrake sink. This might be useful when you want to avoid some messages going to Airbrake or deduplicate similar messages (anti-flood).

var config = new Sharpbrake.Client.AirbrakeConfig
{...};
 
var config = new LoggerConfiguration()
    .WriteTo.Airbrake(config, LogEventLevel.Fatal, new AibrakeThrottlingFilter())
    .CreateLogger();

where AibrakeThrottlingFilter looks like this:

class AibrakeThrottlingFilter : Sharpbrake.Serilog.ILoggerFilter
    {
        // The main filtering routine
        // returning null means 'don't send'
        public LogEvent Filter(LogEvent logEvent)
        {
            return null; // don't send to Airbrake
        }

        // Airbrake sink will give a 'sender' to the object
        // to allow it to send notifications later
        public void SetNoticeSender(Action<LogEvent> sendAction)
        {
            // this is the sender we can use to send message later
        }
    }

You can build any logic that you want to on top of this interface and use sendAction to send custom messages at any point in time.