DDPlanet.Logging 0.1.9

There is a newer version of this package available.
See the version list below for details.
dotnet add package DDPlanet.Logging --version 0.1.9
NuGet\Install-Package DDPlanet.Logging -Version 0.1.9
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="0.1.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DDPlanet.Logging --version 0.1.9
#r "nuget: DDPlanet.Logging, 0.1.9"
#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 DDPlanet.Logging as a Cake Addin
#addin nuget:?package=DDPlanet.Logging&version=0.1.9

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

DDPlanet.Logging

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

In Program.cs:

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>()
                .UseLogging();

In appsettings.json:

"Logging": {
    "ApplicationName": "some.app", // your application name
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning",
        "IdentityServer4": "Warning"
      }
    },
    "Remote": {
      "LoggingServerNodes": [
        "http://10.77.111.88:9200/" // your Elasticsearch host
      ]
    }
}

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>();

Advanced configuration

.UseLogging() 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 IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .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(config =>
    {
        config.ApplicationName = "some.app"; // your application name
        config.Remote.LoggingServerNodes = new List<Uri>
        {
            new Uri("http://10.77.111.88:9200/") // your Elasticsearch host
        };
    });
}

protected void Application_Error()
{
    var ex = Server.GetLastError();
    Log.Error(ex, "Application_Error");
}

Usage:

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

In Program.cs:

static void Main(string[] args)
{
    Log.Logger = LoggerHelper.GetDefaultLogger(config =>
    {
        config.ApplicationName = "some.app"; // your application name
        config.Remote.LoggingServerNodes = new List<Uri>
        {
            new Uri("http://10.77.111.88:9200/") // your Elasticsearch host
        };
    });

    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:appName" value="some.app"/>
  <add key="Logging:Remote:LoggingServerNodes" value="http://10.77.111.88:9200/, http://some.host:9200"/>
</appSettings>

In Global.asax:

protected void Application_Start()
{
    Log.Logger = LoggerHelper.GetDefaultLogger(config =>
    {
        config.ApplicationName = ConfigurationManager.AppSettings["Logging:appName"];
        var elkNodes = ConfigurationManager.AppSettings["Logging:Remote:LoggingServerNodes"]
            .Split(',')
            .Select(node => new Uri(node.Trim()))
            .ToList();
        config.Remote.LoggingServerNodes = elkNodes;
    });
}
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 is compatible.  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
4.2.0 7,641 8/14/2023
4.1.0 39,073 2/9/2021
4.0.2 8,611 11/9/2020
4.0.1 598 11/9/2020
4.0.0 614 10/22/2020
3.1.1 6,686 8/13/2020
3.1.0 1,393 8/5/2020
3.0.1 8,531 3/13/2020
3.0.0 7,791 10/3/2019
2.0.0 579 10/2/2019
1.0.2 1,766 9/9/2019
1.0.1 3,179 8/7/2019
1.0.0 562 8/7/2019
0.1.9 2,951 5/6/2019
0.1.7 665 4/30/2019
0.1.6 593 4/29/2019
0.1.5 763 4/24/2019