Nodinite.Serilog.EventHubSink 1.2.0

Nodinite.Serilog.EventHubSink

A Serilog sink that writes log events to a Microsoft Azure Event Hub.

This project is built with .NET Standard 2.0.

Get Started

Install Nodinite.Serilog.EventHubSink Nuget Package

Start by installing the NuGet package Nodinite.Serilog.Sink.Core.

Install-Package Nodinite.Serilog.EventHubSink

Set up

Nodinite requires some settings to be configured in order for events to be logged. Below you can see all settings that need to be configured.

Using code

Besides Serilog, the following nuget packages need to be installed

• Nodinite.Serilog.EventHubSink

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

var connectionString = "{Your EventHub Connection String";

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

ILogger log = new LoggerConfiguration()
    .WriteTo.NodiniteEventHubSink(connectionString, settings)
    .CreateLogger()
    .ForContext("ApplicationInterchangeId", $"CustomId-{Guid.NewGuid().ToString()}")
    .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.EventHubSink
• 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.EventHubSink" ],
    "WriteTo": [
      {
        "Name": "NodiniteEventHubSink",
        "Args": {
          "ConnectionString": "",
          "Settings": {
            "LogAgentValueId": 503,
            "EndPointName": "Nodinite.Serilog.EventHubSink.Tests",
            "EndPointUri": "Nodinite.Serilog.EventHubSink.Tests.Serilog",
            "EndPointDirection": 0,
            "EndPointTypeId": 0,
            "OriginalMessageTypeName": "Serilog.LogEvent",
            "ProcessingUser": "NODINITE",
            "ProcessName": "Nodinite.Serilog.EventHubSink.Tests",
            "ProcessingMachineName": "NODINITE-DEV",
            "ProcessingModuleName": "DOTNETCORE.TESTS",
            "ProcessingModuleType": "DOTNETCORE.TESTPROJECT"
          }
        }
      }
    ]
  }
}

Logging Context Properties

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

Example: