Nodinite.Serilog.FileSink 2.0.8

dotnet add package Nodinite.Serilog.FileSink --version 2.0.8
NuGet\Install-Package Nodinite.Serilog.FileSink -Version 2.0.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nodinite.Serilog.FileSink" Version="2.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nodinite.Serilog.FileSink --version 2.0.8
#r "nuget: Nodinite.Serilog.FileSink, 2.0.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nodinite.Serilog.FileSink as a Cake Addin
#addin nuget:?package=Nodinite.Serilog.FileSink&version=2.0.8

// Install Nodinite.Serilog.FileSink as a Cake Tool
#tool nuget:?package=Nodinite.Serilog.FileSink&version=2.0.8

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

Documentation for Nodinite.Serilog.FileSink can be found here.

Configuration

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.

Field Example Value Comment
LogAgentValueId 503 Who (Log Agents) sent the data
EndPointName "Nodinite.Serilog.FileSink.Tests" Name of Endpoint transport
EndPointUri "Nodinite.Serilog.FileSink.Tests.Serilog" URI for Endpoint transport
EndPointDirection 0 Direction for Endpoint transport
EndPointTypeId 0 Type of Endpoint transport
OriginalMessageTypeName "Serilog.LogEvent" Message Type Name
ProcessingUser "Nodinite" Log Identity
ProcessName "My customer import process" Name of process
ProcessingMachineName "localhost" Name of server where log event originated
ProcessingModuleName "INT101-HelloHappyCustomers-Application" Name of module
ProcessingModuleType "FileImport" Type of module, exe, dll, service

Using code

Besides Serilog, the following nuget packages need to be installed

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

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.8 78 4/10/2024
2.0.7 88 3/13/2024
2.0.6 105 2/14/2024
2.0.4 152 1/10/2024
2.0.2 165 11/15/2023
2.0.1 147 11/6/2023
2.0.0 396 2/13/2023
1.4.0 204 2/9/2023
1.3.0 701 2/21/2022
1.2.0 413 2/14/2022
1.0.2 518 3/30/2020
1.0.1 460 2/28/2020
1.0.0 513 2/28/2020