Merge pull request #6 from Mathavana/develop

Develop - Logger (Serilog)

Author: MathavanN

.gitignore

@@ -6,4 +6,5 @@ Supermarket.Identity/obj/**
 Supermarket.Persistent/bin/**
 Supermarket.Persistent/obj/**
 Supermarket/bin/**
-Supermarket/obj/**
+Supermarket/obj/**
+Supermarket/LogFiles/**

README.md

@@ -6,11 +6,11 @@ We will try to create an API application using asp.net core.
 - ASP NET Identity, JWT Authentication implemented in a separate DB
 - Swagger for API Document
 - API Version
+- Logging (Serilog)
 
 ### Next ToDo List:
 - Role Based Authentication/Authorization
 - Standard response for both error/success results
-- Logging
 - Global Error Handling
 - Dockerization
 

Supermarket/Startup.cs

@@ -5,7 +5,9 @@
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Newtonsoft.Json.Serialization;
+using Serilog;
 using Supermarket.Extensions;
 using Supermarket.Resources;
 
@@ -15,6 +17,8 @@ public class Startup
     {
         public Startup(IConfiguration configuration)
         {
+            //Initialize Serilog configuration
+            Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(configuration).CreateLogger();
             Configuration = configuration;
         }
 
@@ -58,8 +62,10 @@ public void ConfigureServices(IServiceCollection services)
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
-        public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApiVersionDescriptionProvider provider)
+        public void Configure(IApplicationBuilder app, IHostingEnvironment env, 
+            IApiVersionDescriptionProvider provider, ILoggerFactory loggerFactory)
         {
+            loggerFactory.AddSerilog();
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();

Supermarket/Supermarket.csproj

@@ -18,6 +18,9 @@
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="3.2.0" />
     <PackageReference Include="Microsoft.AspNetCore.Razor.Design" Version="2.2.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="2.2.0" />
+    <PackageReference Include="Serilog.AspNetCore" Version="2.1.1" />
+    <PackageReference Include="Serilog.Settings.Configuration" Version="3.0.1" />
+    <PackageReference Include="Serilog.Sinks.RollingFile" Version="3.3.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="4.0.1" />
   </ItemGroup>
 

Supermarket/Swagger/SwaggerInfo.cs

@@ -16,7 +16,7 @@ public static Info CreateInfoForApiVersion(ApiVersionDescription description, Ty
             {
                 Title = $"{type.Assembly.GetCustomAttribute<AssemblyProductAttribute>().Product} {description.ApiVersion}",
                 Version = description.ApiVersion.ToString(),
-                Description = "A simple example ASP.NET Core Web API",
+                Description = "Supermarket ASP.NET Core Web API",
                 TermsOfService = "None",
                 Contact = new Contact { Name = "Mathavan N", Email = "mathavan@gmail.com", Url = "https://github.com/Mathavana" },
                 License = new License { Name = "Use under LICX", Url = "https://example.com/license" }

Supermarket/V1/Controllers/AboutController.cs

@@ -1,15 +1,25 @@
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 
 namespace Supermarket.V1.Controller
 {
     [ApiController]
-    [ApiVersion("1.0")]
+    [ApiVersion("1.0", Deprecated = true)]
     [Route("api/v{version:apiVersion}/[controller]")]
     public class AboutController : ControllerBase
     {
+        private readonly ILogger<AboutController> _logger;
+
+        public AboutController(ILogger<AboutController> logger)
+        {
+            _logger = logger;
+        }
+
         [HttpGet]
         public IActionResult Get()
         {
+            _logger.LogInformation("Still consuming deprecated api method");
+
             return Ok(new { message = "This is about Api Version 1.0" });
         }
     }

Supermarket/appsettings.json

@@ -1,7 +1,17 @@
 {
-  "Logging": {
-    "LogLevel": {
-      "Default": "Warning"
+  "Serilog": {
+    "MinimumLevel": "Information",
+    "WriteTo": [
+      {
+        "Name": "RollingFile",
+        "Args": {
+          "pathFormat": "LogFiles/FileOn_{Date}.txt",
+          "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}"
+        }
+      }
+    ],
+    "Properties": {
+      "Application": "Supermarket ASP.NET Core Web API"
     }
   },
   "ConnectionStrings": {