Nodinite.Serilog.ServiceBusSink 2.0.16

Nodinite.Serilog.ServiceBusSink

Nodinite.Serilog.ServiceBusSink is a custom sink for Serilog designed to send a Nodinite logging events to a Microsoft Azure Service Bus Queue. Unlike the default Serilog sinks that write logs to a file, database, or other conventional destinations, this sink forwards the Nodinite log events to your Azure Service Bus Queue directly, which later picked up by the Nodinite Pickup service for further forwarding into Nodinite.

Features

• Real-time logging: Events are sent to Microsoft Azure Service Bus Queue.
• Seamless Integration: Works well with existing Serilog configurations.
• Customizable: Supports additional custom fields to send along with the log events (CONTEXT PROPERTIES).

Documentation

Nodinite - Docs
Nodinite - Serilog Docs

Configuration

A Nodinite Log Event has mandatory and optional fields. Below is an example to get you started.

Using code

Besides Serilog, the following nuget packages need to be installed

• Nodinite.Serilog.ServiceBusSink

Using the following code below you can start logging events to Nodinite.

var connectionString = "{Your ServiceBus Connection String";
var queueName = "{Your ServiceBus Queue Name}";

var settings = new NodiniteLogEventSettings()
{
    LogAgentValueId = 503,
    EndPointDirection = 0,
    EndPointTypeId = 0,
    EndPointUri = "Nodinite.Serilog.ServiceBusSink.Tests.Serilog",
    EndPointName = "Nodinite.Serilog.ServiceBusSink.Tests",
    ProcessingUser = "NODINITE",
    ProcessName = "Nodinite.Serilog.ServiceBusSink.Tests",
    ProcessingMachineName = "NODINITE-DEV",
    ProcessingModuleName = "DOTNETCORE.TESTS",
    ProcessingModuleType = "DOTNETCORE.TESTPROJECT"
};

ILogger log = new LoggerConfiguration()
    .WriteTo.NodiniteServiceBusSink(connectionString, queueName, settings)
    .CreateLogger()
    .ForContext("ApplicationInterchangeId", $"CustomId-{Guid.NewGuid().ToString()}")
    .ForContext("CustomerId", 12)
    .ForContext("Body", JsonConvert.SerializeObject(new { Id = 1 }))
    .ForContext("OriginalMessageType", "TestMessage#1.0");

Using Appsettings.json (Preferred)

Besides Serilog, the following nuget packages need to be installed

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Configuration.Json
• Nodinite.Serilog.ServiceBusSink
• Serilog.Settings.Configuration

Using the following code to initialize the logger in your application:

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

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

And putting the following into your appsettings.json:

{
  "Serilog": {
    "Using": [ "Nodinite.Serilog.ServiceBusSink" ],
    "WriteTo": [
      {
        "Name": "NodiniteServiceBusSink",
        "Args": {
          "ConnectionString": "",
          "QueueName":  "",
          "Settings": {
            "LogAgentValueId": 503,
            "EndPointName": "Nodinite.Serilog.ServiceBusSink.Tests",
            "EndPointUri": "Nodinite.Serilog.ServiceBusSink.Tests.Serilog",
            "EndPointDirection": 0,
            "EndPointTypeId": 0,
            "OriginalMessageTypeName": "Serilog.LogEvent",
            "ProcessingUser": "NODINITE",
            "ProcessName": "Nodinite.Serilog.ServiceBusSink.Tests",
            "ProcessingMachineName": "NODINITE-DEV",
            "ProcessingModuleName": "DOTNETCORE.TESTS",
            "ProcessingModuleType": "DOTNETCORE.TESTPROJECT"
          }
        }
      }
    ]
  }
}

Logging Context Properties

ILogger log = new LoggerConfiguration()
    .WriteTo.NodiniteServiceBusSink(connectionString, queueName, settings)
    .CreateLogger()
    .ForContext("CorrelationId", Guid.NewGuid())
    .ForContext("CustomerId", 12);

log.Information("Customer '12' has been imported.");

The Serilog sink will automatically loop over all context properties you have defined in your code and log them as part of your event to Nodinite.

Support

For bugs, feature requests, or other concerns, please contact us at support@nodinite.com.