Nodinite.Serilog.FileSink 2.0.16

Nodinite.Serilog.FileSink

Nodinite.Serilog.FileSink is a custom sink for Serilog that enables sending Nodinite logging events to an SMB folder. With this sink, Nodinite log events can be seamlessly forwarded to your SMB folder, which later picked up by the Nodinite Pickup service for further forwarding into Nodinite.

Features

• Real-time logging: Events are sent to SMB folder as they occur.
• 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.FileSink

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

var folder = "{Your Folder}";

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

ILogger log = new LoggerConfiguration()
    .WriteTo.NodiniteFileSink(folder, 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.FileSink
• 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.FileSink" ],
    "WriteTo": [
      {
        "Name": "FileSink",
        "Args": {
          "Folder": "",
          "Settings": {
            "LogAgentValueId": 503,
            "EndPointName": "Nodinite.Serilog.FileSink.Tests",
            "EndPointUri": "Nodinite.Serilog.FileSink.Tests.Serilog",
            "EndPointDirection": 0,
            "EndPointTypeId": 0,
            "OriginalMessageTypeName": "Serilog.LogEvent",
            "ProcessingUser": "NODINITE",
            "ProcessName": "Nodinite.Serilog.FileSink.Tests",
            "ProcessingMachineName": "NODINITE-DEV",
            "ProcessingModuleName": "DOTNETCORE.TESTS",
            "ProcessingModuleType": "DOTNETCORE.TESTPROJECT"
          }
        }
      }
    ]
  }
}

Logging Context Properties

ILogger log = new LoggerConfiguration()
    .WriteTo.NodiniteFileSink(folder, 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.