Serilog.Sinks.RabbitMQ.Publisher 1.0.1

Serilog.Sinks.RabbitMQ by Cmargok

Why I made this new version

Picture a world in constant evolution, where C# and .NET advance by leaps and bounds. In this scenario, updating and migrating libraries becomes crucial. And what happens in distributed systems? Centralizing logs emerges as a brilliant option. That's why we've implemented a Serilog Sink that sends logs via events to RabbitMQ. We used the library https://github.com/lyng-dev/serilog-sinks-rabbitmq as a base, leveraging the new features offered by .NET 8 and C# 12 to expand its functionalities.

Dependencies

Installation

Using Nuget:

dotnet add package Serilog.Sinks.RabbitMQ.Publisher --version 1.0.0

Version 1.0.0 configuration

We can configure the RabbitMQSink in many ways

• usings

using Serilog.Sinks.RabbitMQ.Core.Provider;
using Serilog.Sinks.RabbitMQ.TransversalConfiguration;

Declare UseSerilog

builder.Host.UseSerilog();

• Using appsettings.json

 "EventLogPublisher": {
    "ApiName": "MyApi",
    "Username": "UserIsMyName",
    "Password": "myPassUltraSecure",
    "Hostnames": [ "localhost" ],
    "ExchangeName": "exchangeToTesting",
    "ExchangeType": "direct",
    "Port": 5672,
    "RouteKey": "logs"
  }

To call it from program.cs, we use the extension method builder.Configuration.GetEventLogPublisherSettings(). This will read the settings we've added in the JSON file. Don't forget to call the CopyFrom method to copy the data into the sink.

builder.Services
    .AddEventLogPublisher((EventLogConfig, sinkSetting) =>
    {
        EventLogConfig.CopyFrom(builder.Configuration.GetEventLogPublisherSettings());
        sinkSetting.BatchPostingLimit = 50;
        sinkSetting.Period = TimeSpan.FromSeconds(10);
        sinkSetting.QueueLimit = 500;
        sinkSetting.LogMinimumLevel = LogEventLevel.Warning;
    })
    .RegisterPublisher();

• Register properties by creating a new instace of EventClientConfiguration

builder.Services
    .AddEventLogPublisher((EventLogConfig, sinkSetting) =>
    {
        EventLogConfig.CopyFrom(new EventClientConfiguration()
        {
            ApiName = "MyApi",
            Username = "UserIsMyName",
            Password = "myPassUltraSecure",
            Hostnames = ["localhost"],
            ExchangeName = "exchangeToTesting",
            ExchangeType = "direct",
            Port = 5672,
            DeliveryMode = RabbitMQDeliveryMode.Durable,
            RouteKey = "logs",
        });
        sinkSetting.BatchPostingLimit = 50;
        sinkSetting.Period = TimeSpan.FromSeconds(10);
        sinkSetting.QueueLimit = 500;
        sinkSetting.LogMinimumLevel = LogEventLevel.Warning;
    })
    .RegisterPublisher();

Don't forget to call the CopyFrom method to copy the data into the sink.

• Register properties once at time

builder.Services
    .AddEventLogPublisher((EventLogConfig, sinkSetting) =>
    {
        EventLogConfig.ApiName = "MyApi";
        EventLogConfig.Username = "UserIsMyName";
        EventLogConfig.Password = "myPassUltraSecure";
        EventLogConfig.Hostnames = ["localhost"];
        EventLogConfig.ExchangeName = "exchangeToTesting";
        EventLogConfig.ExchangeType = "direct";
        EventLogConfig.Port = 5672;
        EventLogConfig.DeliveryMode = RabbitMQDeliveryMode.Durable;
        EventLogConfig.RouteKey = "logs";        
        sinkSetting.BatchPostingLimit = 50;
        sinkSetting.Period = TimeSpan.FromSeconds(10);
        sinkSetting.QueueLimit = 500;
        sinkSetting.LogMinimumLevel = LogEventLevel.Warning;
    })
    .RegisterPublisher();

• Of Course you can mix them however you want

Adding more sinks into RabbitMQ.Sink Configuration

The method RegisterPublisher receives 3 parameters

• First one

Action<LoggerConfiguration> loggerConfig = null!, 

we can add new sinks or let it by default

builder.Services
    .AddEventLogPublisher((EventLogConfig, sinkSetting) =>
    {
        EventLogConfig.CopyFrom(builder.Configuration.GetEventLogPublisherSettings());
        sinkSetting.BatchPostingLimit = 50;
        sinkSetting.Period = TimeSpan.FromSeconds(10);
        sinkSetting.QueueLimit = 500;
        sinkSetting.LogMinimumLevel = LogEventLevel.Warning;
    })
    .RegisterPublisher(logger =>
    {
        logger.WriteTo.Logger(cl => cl
            .Filter.ByIncludingOnly(e => e.Level > LogEventLevel.Debug)
            .WriteTo.Console());
    }
);

• Second one

bool SleepRabbitMQClientLogger = false

If you set the property in true, the RabbitMQ sink will be disabled, "not loaded at all"

• Third one

* bool UseDefaultLogger = false

I've implemented a centralized logger called EventLogger who uses the interface IEventLogger

public interface IEventLogger
{
    public void LoggingInformation(string message);
    public void LoggingWarning(string message);        
    public void LoggingError(Exception ex, string message);
}

If you set the propertie in false, the logger I've made wont registered in serviceCollection, you are free to use the centralized implementation made by your own or by using the Ilogger<T> implementation.

Middleware to catch dispose sink Exceptions

use the EventLogBusExceptionMiddleware to catch any exception caused by disposing all the stuff used to run this library treating with rabbitmq client and threadsafe implementation. This middleware uses the HandleExceptionAsync method to handle the list of exceptions, you can overwrite it to re implement the functionality. The exception we use to catch is EventLogBusException

public virtual async Task HandleExceptionAsync(EventLogBusException exceptions)
{
   foreach (var ex in exceptions._innerExceptions)
   {
       await Console.Out.WriteLineAsync("Source ->" + ex.Source + "\n message -> " + ex.Message);
   }
}

Don't forget register the middleware

using EventLogBus.Expose.Middleware;

//==================== MiddleWares ===============================
app.UseMiddleware<EventLogBusExceptionMiddleware>();

References

• Serilog
• Logging in ASP.Net Core
• Dependency Injection in ASP.Net Core