SoftlareStruct.Logger 1.0.3

<a name="readme-top"></a>

About The Project

Getting Started

This package is a simple logger for your application. It is designed to be simple and easy to use. Espacially for SoftlareStruct projects.

Installation

Below you will find the installation instructions for the package.

1. Here is the package link in Nuget.org. https://www.nuget.org/packages/SoftlareStruct.Logger

2. Install the package via Nuget Package Manager Console.

   Install-Package SoftlareStruct.Logger
   

3. Add the following code to your Startup.cs file.

    public void ConfigureServices(IServiceCollection services)
    {           
        services.AddSoftlareLogger(Configuration);
    }
   

4. Add the following code to your Program.cs file.

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

5. If you want to keep RequestUserId in your logs, you should add the following code to your Configure method in Startup.cs file.

   app.UseMiddleware<CatchUserIdMiddleware>();
   

Usage

There are two ways to use the logger. You can use it in your controllers or services.

1. In your controller, you can use it like this. This way is recommended because it is include SourceContext.

   public class HomeController : Controller
   {
       private readonly ILogger<HomeController> _logger;
   
       public HomeController(ILogger<HomeController> logger)
       {
    	   _logger = logger;
       }
   
       public IActionResult Index()
       {
    	   _logger.LogInformation("This is a log message.");
    	   return View();
       }
   }
   

2. You can use Static Log class wherever you want.

    public class HomeController : Controller
    {
    	public IActionResult Index()
    	{
    		Log.Information("This is a log message.");
    		return View();
    	}
    }
   

3. You should add the following code to your appsettings.json file. Or If you have different environment configuration files, you can seperate config however you want. Elastic Config is optional. If you want to use ElasticSearch, you should add Elastic Config.

    "Softlare": {
       "Application": "[APPLICATIONNAME]",
       "Environment": "Production",
       "ElasticLogHost": {
         "Host": "http://localhost:9200/",
         "UserName": "[ELASTICUSERNAME]",
         "Password": "[ELASTICPASSWORD]"
       }
     },
      "Serilog": {
       "MinimumLevel": {
         "Default": "Information",
         "Override": {
           "Microsoft": "Information",
           "System": "Information",
           "Microsoft.AspNetCore": "Information",
           "Microsoft.EntityFrameworkCore": "Information",
           "Microsoft.EntityFrameworkCore.Database.Command": "Warning",
           "Microsoft.EntityFrameworkCore.Infrastructure": "Information",
           "Microsoft.EntityFrameworkCore.Query": "Information",
           "Microsoft.AspNetCore.Hosting": "Information", //RequestLoggingMiddleware
           "Microsoft.AspNetCore.Routing": "Warning", //RequestLoggingMiddleware
           "Microsoft.AspNetCore.Mvc": "Information", //RequestLoggingMiddleware 
           "Microsoft.AspNetCore.Mvc.Infrastructure.ObjectResultExecutor": "Warning" //RequestLoggingMiddleware"
         }
       },
       "WriteTo": [
         {
           "Name": "Seq",
           "Args": {
             "serverUrl": "http://localhost:5341",
             "apiKey": "[APIKEY]"
           }
         },      
         {
           "Name": "File",
           "Args": {
             "path": "logs/log-.json",
             "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact",
             "rollingInterval": "Day",
             "rollOnFileSizeLimit": true,
             "fileSizeLimitBytes": 5242880, //5mb
             "retainedFileCountLimit": 7,
             "restrictedToMinimumLevel": "Warning"
           }
         }
       ]
     }
   

<p align="right">(<a href="#readme-top">back to top</a>)</p>