This project has been merged into SumoLogic .NET appenders repository!

W4k.Serilog.Sinks.SumoLogic has been merged to SumoLogic/sumologic-net-appenders. From now on, reference SumoLogic.Logging.Serilog package instead.

In order to follow SumoLogic terminology, one change was made when naming appenders. To migrate, rename sinks accordingly:

(So as you can see, in SumoLogic package, buffered sink is named explicitly)

Serilog sink for logging events into SumoLogic.

Code is inspired by Bill Pratt's Serilog.Sinks.SumoLogic (billpratt/serilog-sinks-sumologic) and SumoLogic own appenders for log4net and NLog (SumoLogic/sumologic-net-appenders).

Install-Package Serilog
Install-Package W4k.Serilog.Sinks.SumoLogic

There are two Serilog sinks included in this package:

• SumoLogicSink: Uses buffer to collect events, which are being sent in batches (extension method: SumoLogic)
• SumoLogicUnbufferedSink: Sends event right away (extension method: SumoLogicUnbuffered)

To set up logger using configuration file, additional dependency is required - install Serilog.Settings.Configuration as well.

Install-Package Serilog.Settings.Configuration

Add appsettings.json (or whatever configuration you need) as follows:

{
  "Serilog": {
    "WriteTo": [
      {
        "Name": "SumoLogic",
        "Args": {
          "endpointUrl": "https://localhost",
          "sourceName": "w4k-serilog-sumologic"
        }
      }
    ]
  }
}

Notice property Name - either use SumoLogic or SumoLogicUnbuffered. Detailed description of configuration properties are listed in Configuration section.

To load such configuration, use Serilog's ReadFrom method like this:

IConfigurationRoot configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

Logger log = new LoggerConfiguration()
    .ReadFrom.Configuration(configuration)
    .CreateLogger();

It is possible set up logger using extension method as well:

// alternatively .WriteTo.SumoLogicUnbuffered(...)
Logger log = new LoggerConfiguration()
    .WriteTo.SumoLogic(new Uri("http://localhost"), sourceName: "w4k-serilog-sumologic")
    .CreateLogger();

When logging to SumoLogic, you may find useful to log JSON instead of plain text message. It is possible to configure JSON formatter (Serilog.Formatting.Compact.CompactJsonFormatter) following way.

First install package containing JSON formatter:

Install-Package Serilog.Formatting.Compact

Then use extension method to assign new formatter to formatter argument:

new LoggerConfiguration().
  .WriteTo.SumoLogic(new Uri("http://localhost"), formatter: new CompactJsonFormatter())
  .CreateLogger();

Alternatively, you can configure formatter in config file (see Configuration section):

{
  "Serilog": {
    "WriteTo": [
      {
        "Name": "SumoLogic",
        "Args": {
          "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact",
          "endpointUrl": "https://localhost",
        }
      }
    ]
  }
}

Either use as sink arguments in configuration or as name arguments of extension methods.

arguments marked with "(B)" are available only to buffered sink (SumoLogicSink)

• default outputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message} {Exception}", see DefaultOutputTemplate
• provide HttpMessageHandler httpMessageHandler to adjust HTTP request sent SumoLogic
• when LoggingLevelSwitch levelSwitch is set, LogEventLevel restrictedToMinimumLevel argument is ignored
• when setting text formatter (ITextFormatter formatter), always use fully qualified type name (if set, string outputTemplate is ignored)