DDPlanet.Logging 4.1.0

.NET 5.0 .NET Framework 4.7.2
dotnet add package DDPlanet.Logging --version 4.1.0
NuGet\Install-Package DDPlanet.Logging -Version 4.1.0
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="DDPlanet.Logging" Version="4.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DDPlanet.Logging --version 4.1.0
#r "nuget: DDPlanet.Logging, 4.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install DDPlanet.Logging as a Cake Addin
#addin nuget:?package=DDPlanet.Logging&version=4.1.0

// Install DDPlanet.Logging as a Cake Tool
#tool nuget:?package=DDPlanet.Logging&version=4.1.0

DDPlanet.Logging

Developed by DDPlanet

Summary

DDPlanet.Logging is simple logging framework developed for ELK stack based on Serilog. It will provide fully configured logging in just a couple lines of code.

Base concept

All logs will be sent on remote ELK server and duplicated to console and small local rolling file.

Installation

NuGet package available

Package manager:

Install-Package DDPlanet.Logging

.NET CLI:

dotnet add package DDPlanet.Logging

Usage

ASP.NET Core

Quick start
ASP.NET Core

In Program.cs:

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .UseLogging()
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

In appsettings.json:

"Logging": {
    "ApplicationName": "some.app", // your application name
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning",
        "IdentityServer4": "Warning",
        "Elastic.Apm": "Warning"
      }
    },
    "Remote": {
      "LoggingServer": "http://localhost:31311"
    }
},
"ElasticApm": {
    "ServiceName": "some.app",
    "ServerUrls": "http://localhost:6200",
    "TransactionSampleRate": 1.0
}

In Startup.cs:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseApm(Configuration);
    app.UseRequestLogging();
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
    }

    app.UseStaticFiles();
    app.UseRouting();
    app.UseAuthorization();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
    });
}

Usage:

public class HomeController : Controller
{
    private readonly ILogger _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public ActionResult Info()
    {
        _logger.LogInformation("Test message");
        return View();
    }
}

If you use a custom class (not an MVC controller) it must be registered in Startup.cs. ConfigureServices: services.AddScoped<ICustomService, CustomService>();

It is always better to use ASP.NET Core despite overhead

In Program.cs:

static void Main(string[] args)
{
    Log.Logger = LoggerHelper.GetDefaultLogger();

    Log.Information("Test message");

    Console.WriteLine("Message sent.");
    Console.ReadLine();
}

In appsettings.json: same as ASP.NET Core

Advanced configuration

.UseLogging() and GetDefaultLogger() both can be additionally configured with parameters configure (main settings) or postConfigure (underlaying Serilog settings). Such configuration has priority under configuration file. All concurrent values from appsettings.json will be overwritten!

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });
        .UseLogging(
            configure: settings =>
            {
                settings.ApplicationName = "another.name";
                settings.Environment = "Staging";
                settings.Remote.FallbackFile.Path = "custom.log";
            },
            postConfigure: serilogSettings =>
            {
                serilogSettings.Enrich.WithProperty("someProp", "someValue");
            });

.NET Framework

Quick start
ASP.NET MVC

In Global.asax:

protected void Application_Start()
{
    Log.Logger = LoggerHelper.GetDefaultLogger(
    environment: "Developnemt",
    config =>
    {
        config.ApplicationName = "some.app"; // your application name
        config.Remote.LoggingServer = new Uri(ConfigurationManager.AppSettings["Logging:Remote:LoggingServer"].Trim());
    });
}

Usage:

public ActionResult Info()
{
    Log.Information("Test message");
    return View();
}
Console app

In Program.cs:

static void Main(string[] args)
{
    Log.Logger = LoggerHelper.GetDefaultLogger(
    environment: "Developnemt",
    config =>
    {
        config.ApplicationName = "some.app"; // your application name
        config.Remote.LoggingServer = new Uri("http://localhost:9200/");
    });

    Log.Information("Test message");
}
Advanced configuration

Best practices is storing all you configuration values in Web.config or App.config. In Web.config:

<appSettings>
  <add key="Logging:Environment" value="Development"/>
  <add key="Logging:ApplicationName" value="test.app"/>
  <add key="Logging:Remote:LoggingServer" value="http://localhost:9200/"/>
</appSettings>

In Global.asax:

protected void Application_Start()
{
    Log.Logger = LoggerHelper.GetDefaultLogger(
        ConfigurationManager.AppSettings["Logging:Environment"],
        config =>
        {
            config.ApplicationName = ConfigurationManager.AppSettings["Logging:ApplicationName"];
            var logstashUri = new Uri(ConfigurationManager.AppSettings["Logging:Remote:LoggingServer"].Trim());
            config.Remote.LoggingServer = logstashUri;
        });
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Framework net472 net48
Compatible target framework(s)
Additional computed target framework(s)
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
4.1.0 33,603 2/9/2021
4.0.2 8,462 11/9/2020
4.0.1 472 11/9/2020
4.0.0 494 10/22/2020
3.1.1 6,569 8/13/2020
3.1.0 1,264 8/5/2020
3.0.1 8,399 3/13/2020
3.0.0 7,625 10/3/2019
2.0.0 439 10/2/2019
1.0.2 1,616 9/9/2019
1.0.1 3,008 8/7/2019
1.0.0 438 8/7/2019
0.1.9 2,811 5/6/2019
0.1.7 528 4/30/2019
0.1.6 473 4/29/2019
0.1.5 658 4/24/2019