DDPlanet.Logging 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>();

.NET Core Console app (Not recommended)

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