Merge pull request #49 from vtex/feature/code_improvement

Caldas · web-flow · commit ad47d438ff27 · 2018-02-22T15:49:13.000-03:00
Feature/code improvement
diff --git a/src/SampleWebAPI/Controllers/ValuesController.cs b/src/SampleWebAPI/Controllers/ValuesController.cs
@@ -3,7 +3,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 
-namespace Vtex.SampleWebAPI.Controllers
+namespace Splunk.SampleWebAPI.Controllers
 {
     [Route("api/[controller]")]
     public class ValuesController : Controller
@@ -20,7 +20,7 @@ public ValuesController(ILoggerFactory loggerFactory)
         public IEnumerable<string> Get()
         {
             var exception = new NotImplementedException();
-            logger.Log(LogLevel.Critical, new EventId(-1, "Values Controller"), new { route = "Get" }, exception, 
+            logger.Log(LogLevel.Trace, new EventId(-1, "Values Controller"), new { route = "Get" }, exception, 
                        (argState, argException) => { 
                 return string.Format("{0} {1}", 
                                      argState != null ? argState.ToString() : string.Empty,
diff --git a/src/SampleWebAPI/Program.cs b/src/SampleWebAPI/Program.cs
@@ -1,7 +1,7 @@
 ﻿using Microsoft.AspNetCore;
 using Microsoft.AspNetCore.Hosting;
 
-namespace Vtex.SampleWebAPI
+namespace Splunk.SampleWebAPI
 {
     public class Program
     {
diff --git a/src/SampleWebAPI/SampleWebAPI.csproj b/src/SampleWebAPI/SampleWebAPI.csproj
@@ -4,15 +4,15 @@
     <TargetFramework>netcoreapp2.0</TargetFramework>
     <ReleaseVersion>1.0.5</ReleaseVersion>
     <Description>Sample Web API project created to show how to use SplunkLogger library</Description>
-    <RootNamespace>Vtex.SampleWebAPI</RootNamespace>
+    <RootNamespace>Splunk.SampleWebAPI</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>
     <Folder Include="wwwroot\" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" />
+    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.5" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/SampleWebAPI/Startup.cs b/src/SampleWebAPI/Startup.cs
@@ -4,10 +4,9 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-using Splunk;
 using Splunk.Configurations;
 
-namespace Vtex.SampleWebAPI
+namespace Splunk.SampleWebAPI
 {
     public class Startup
     {
@@ -36,13 +35,15 @@ public void ConfigureServices(IServiceCollection services)
         /// <param name="loggerFactory">Logger factory.</param>
         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
         {
-            //loggerFactory.AddDebug();
-
-            var splunkLoggerConfigurationOption = app.ApplicationServices.GetService<IOptions<SplunkLoggerConfiguration>>();
-
+            
             /******************************** Define Your Logger *********************************/
             /*                                                                                   */
-            loggerFactory.AddHECRawSplunkLogger(splunkLoggerConfigurationOption.Value);          //
+            // Get Configuration to be used at Logger                                            //
+            var splunkLoggerConfiguration = GetSplunkLoggerConfiguration(app);
+            //                                                                                   //
+            //                       Choose one or more of those loggers                         //
+            //                                                                                   //                                                                                  
+            loggerFactory.AddHECRawSplunkLogger(splunkLoggerConfiguration);                      //
             //                                                                                   //
             //                                                                                   //
             //loggerFactory.AddHECJsonSplunkLogger(splunkConfiguration);                         //
diff --git a/src/SampleWebAPI/appsettings.Development.json b/src/SampleWebAPI/appsettings.Development.json
@@ -4,7 +4,8 @@
     "LogLevel": {
       "Default": "Debug",
       "System": "Information",
-      "Microsoft": "Information"
+      "Microsoft": "Information",
+      "Splunk": "Trace"
     }
   },
   "Splunk": {
@@ -19,8 +20,8 @@
     },
     "SocketConfiguration": {
       "HostName": "localhost",
-      "Port": 4242,
-      "Threshold": "Warning"
-    }
+      "Port": 4242
+    },
+    "Threshold": "Trace"
   }
 }
diff --git a/src/SampleWebAPI/appsettings.json b/src/SampleWebAPI/appsettings.json
@@ -8,7 +8,8 @@
     },
     "Console": {
       "LogLevel": {
-        "Default": "Warning"
+        "Default": "Warning",
+        "Splunk": "Trace"
       }
     },
     "Splunk": {
@@ -23,9 +24,9 @@
       },
       "SocketConfiguration": {
         "HostName": "localhost",
-        "Port": 4242,
-        "Threshold": "Warning"
-      }
+        "Port": 4242
+      },
+      "Threshold": "Trace"
     }
   }
 }
diff --git a/src/SplunkLogger/Loggers/BaseLogger.cs b/src/SplunkLogger/Loggers/BaseLogger.cs
@@ -6,7 +6,7 @@ namespace Splunk.Loggers
     /// <summary>
     /// Define a base logger class.
     /// </summary>
-    public abstract class BaseLogger
+    public abstract class BaseLogger : ILogger
     {
         protected readonly ILoggerFormatter loggerFormatter;
 
@@ -43,5 +43,7 @@ public IDisposable BeginScope<T>(T state)
         {
             return null;
         }
+
+        public abstract void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter);
     }
 }
diff --git a/src/SplunkLogger/Loggers/HECJsonLogger.cs b/src/SplunkLogger/Loggers/HECJsonLogger.cs
@@ -32,7 +32,7 @@ public HECJsonLogger(string categoryName, LogLevel threshold, HttpClient httpCli
         /// <param name="state">Log object state.</param>
         /// <param name="exception">Log Exception.</param>
         /// <param name="formatter">Log text formatter function.</param>
-        public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
+        public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
         {
             SplunkJSONEntry formatedMessage = null;
             if (loggerFormatter != null)
diff --git a/src/SplunkLogger/Loggers/HECRawLogger.cs b/src/SplunkLogger/Loggers/HECRawLogger.cs
@@ -31,7 +31,7 @@ public HECRawLogger(string categoryName, LogLevel threshold, HttpClient httpClie
         /// <param name="state">Log object state.</param>
         /// <param name="exception">Log Exception.</param>
         /// <param name="formatter">Log text formatter function.</param>
-        public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
+        public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
diff --git a/src/SplunkLogger/Loggers/TcpLogger.cs b/src/SplunkLogger/Loggers/TcpLogger.cs
@@ -34,7 +34,7 @@ public TcpLogger(string categoryName, LogLevel threshold, TcpClient tcpClient, I
         /// <param name="state">Log object state.</param>
         /// <param name="exception">Log Exception.</param>
         /// <param name="formatter">Log text formatter function.</param>
-        public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
+        public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
diff --git a/src/SplunkLogger/Loggers/UdpLogger.cs b/src/SplunkLogger/Loggers/UdpLogger.cs
@@ -34,7 +34,7 @@ public UdpLogger(string categoryName, LogLevel threshold, UdpClient udpClient, I
         /// <param name="state">Log object state.</param>
         /// <param name="exception">Log Exception.</param>
         /// <param name="formatter">Log text formatter function.</param>
-        public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
+        public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
diff --git a/src/SplunkLogger/Providers/SplunkHECBaseProvider.cs b/src/SplunkLogger/Providers/SplunkHECBaseProvider.cs
@@ -1,6 +1,8 @@
 ﻿using System;
+using System.Diagnostics;
 using System.Net.Http;
 using System.Net.Http.Headers;
+using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using Splunk.Configurations;
 
@@ -73,5 +75,49 @@ Uri GetSplunkCollectorUrl(SplunkLoggerConfiguration configuration, string endPoi
 
             return new Uri(splunkCollectorUrl);
         }
+
+        protected void DebugSplunkResponse(Task<HttpResponseMessage> responseMessageTask, string loggerType)
+        {
+            if (responseMessageTask.IsCompletedSuccessfully)
+            {
+                switch (responseMessageTask.Result.StatusCode)
+                {
+                    case System.Net.HttpStatusCode.OK:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Request completed successfully.");
+                        break;
+                    case System.Net.HttpStatusCode.Created:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Create request completed successfully.");
+                        break;
+                    case System.Net.HttpStatusCode.BadRequest:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Request error. See response body for details.");
+                        break;
+                    case System.Net.HttpStatusCode.Unauthorized:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Authentication failure, invalid access credentials.");
+                        break;
+                    case System.Net.HttpStatusCode.PaymentRequired:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: In-use Splunk Enterprise license disables this feature.");
+                        break;
+                    case System.Net.HttpStatusCode.Forbidden:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Insufficient permission.");
+                        break;
+                    case System.Net.HttpStatusCode.NotFound:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Requested endpoint does not exist.");
+                        break;
+                    case System.Net.HttpStatusCode.Conflict:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Invalid operation for this endpoint. See response body for details.");
+                        break;
+                    case System.Net.HttpStatusCode.InternalServerError:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Unspecified internal server error. See response body for details.");
+                        break;
+                    case System.Net.HttpStatusCode.ServiceUnavailable:
+                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Feature is disabled in configuration file.");
+                        break;
+                }
+            }
+            else if (responseMessageTask.IsCanceled)
+                Debug.WriteLine($"Splunk HEC {loggerType} Status: Canceled");
+            else
+                Debug.WriteLine($"Splunk HEC {loggerType} Status: Error " + responseMessageTask.Exception != null ? responseMessageTask.Exception.ToString() : "");
+        }
     }
 }
diff --git a/src/SplunkLogger/Providers/SplunkHECJsonLoggerProvider.cs b/src/SplunkLogger/Providers/SplunkHECJsonLoggerProvider.cs
@@ -1,10 +1,7 @@
-﻿using System;
-using System.Collections.Concurrent;
+﻿using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.Net.Http;
-using System.Net.Http.Headers;
 using System.Text;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
@@ -85,48 +82,7 @@ public void Emit(List<object> events)
             var formatedMessage = string.Join(" ", jArray);
             var stringContent = new StringContent(formatedMessage, Encoding.UTF8, "application/json");
             httpClient.PostAsync(string.Empty, stringContent)
-                      .ContinueWith(task => {
-                          if (task.IsCompletedSuccessfully)
-                              switch (task.Result.StatusCode)
-                              {
-                                  case System.Net.HttpStatusCode.OK:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Request completed successfully.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Created:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Create request completed successfully.");
-                                      break;
-                                  case System.Net.HttpStatusCode.BadRequest:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Request error. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Unauthorized:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Authentication failure, invalid access credentials.");
-                                      break;
-                                  case System.Net.HttpStatusCode.PaymentRequired:
-                                      Debug.WriteLine("Splunk HEC JSON Status: In-use Splunk Enterprise license disables this feature.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Forbidden:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Insufficient permission.");
-                                      break;
-                                  case System.Net.HttpStatusCode.NotFound:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Requested endpoint does not exist.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Conflict:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Invalid operation for this endpoint. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.InternalServerError:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Unspecified internal server error. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.ServiceUnavailable:
-                                      Debug.WriteLine("Splunk HEC JSON Status: Feature is disabled in configuration file.");
-                                      break;
-                                  default:
-                                      break;
-                              }
-                          else if (task.IsCanceled)
-                              Debug.WriteLine("Splunk HEC RAW Status: Canceled");
-                          else
-                              Debug.WriteLine("Splunk HEC RAW Status: Error " + task.Exception != null ? task.Exception.ToString() : "");
-                      });
+                      .ContinueWith(task => DebugSplunkResponse(task, "json"));
         }
     }
 }
diff --git a/src/SplunkLogger/Providers/SplunkHECRawLoggerProvider.cs b/src/SplunkLogger/Providers/SplunkHECRawLoggerProvider.cs
@@ -1,7 +1,6 @@
 ﻿using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.Net.Http;
 using Microsoft.Extensions.Logging;
@@ -81,48 +80,7 @@ public void Emit(List<object> events)
             var formatedMessage = string.Join(Environment.NewLine, events.Select(evt => evt.ToString()));
             var stringContent = new StringContent(formatedMessage);
             httpClient.PostAsync(string.Empty, stringContent)
-                      .ContinueWith(task => {
-                          if (task.IsCompletedSuccessfully)
-                              switch (task.Result.StatusCode)
-                              {
-                                  case System.Net.HttpStatusCode.OK:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Request completed successfully.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Created:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Create request completed successfully.");
-                                      break;
-                                  case System.Net.HttpStatusCode.BadRequest:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Request error. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Unauthorized:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Authentication failure, invalid access credentials.");
-                                      break;
-                                  case System.Net.HttpStatusCode.PaymentRequired:
-                                      Debug.WriteLine("Splunk HEC RAW Status: In-use Splunk Enterprise license disables this feature.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Forbidden:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Insufficient permission.");
-                                      break;
-                                  case System.Net.HttpStatusCode.NotFound:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Requested endpoint does not exist.");
-                                      break;
-                                  case System.Net.HttpStatusCode.Conflict:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Invalid operation for this endpoint. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.InternalServerError:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Unspecified internal server error. See response body for details.");
-                                      break;
-                                  case System.Net.HttpStatusCode.ServiceUnavailable:
-                                      Debug.WriteLine("Splunk HEC RAW Status: Feature is disabled in configuration file.");
-                                      break;
-                                  default:
-                                      break;
-                              }
-                          else if (task.IsCanceled)
-                              Debug.WriteLine("Splunk HEC RAW Status: Canceled");
-                          else
-                              Debug.WriteLine("Splunk HEC RAW Status: Error " + task.Exception != null ? task.Exception.ToString() : "");
-                      });
+                      .ContinueWith(task => DebugSplunkResponse(task, "raw"));
         }
     }
 }
diff --git a/src/SplunkLogger/SplunkLogger.csproj b/src/SplunkLogger/SplunkLogger.csproj
@@ -27,7 +27,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="2.0.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="10.0.3" />
-    <PackageReference Include="NuGet.Build.Packaging" Version="0.2.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="11.0.1" />
+    <PackageReference Include="NuGet.Build.Packaging" Version="0.2.2" />
   </ItemGroup>
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using Microsoft.AspNetCore;`
`2`	`2`	`using Microsoft.AspNetCore.Hosting;`
`3`	`3`
`4`		`-namespace Vtex.SampleWebAPI`
	`4`	`+namespace Splunk.SampleWebAPI`
`5`	`5`	`{`
`6`	`6`	`public class Program`
`7`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`},`
`9`	`9`	`"Console": {`
`10`	`10`	`"LogLevel": {`
`11`		`- "Default": "Warning"`
	`11`	`+ "Default": "Warning",`
	`12`	`+ "Splunk": "Trace"`
`12`	`13`	`}`
`13`	`14`	`},`
`14`	`15`	`"Splunk": {`
`@@ -23,9 +24,9 @@`
`23`	`24`	`},`
`24`	`25`	`"SocketConfiguration": {`
`25`	`26`	`"HostName": "localhost",`
`26`		`- "Port": 4242,`
`27`		`- "Threshold": "Warning"`
`28`		`- }`
	`27`	`+ "Port": 4242`
	`28`	`+ },`
	`29`	`+ "Threshold": "Trace"`
`29`	`30`	`}`
`30`	`31`	`}`
`31`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Splunk.Loggers`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// Define a base logger class.`
`8`	`8`	`/// </summary>`
`9`		`- public abstract class BaseLogger`
	`9`	`+ public abstract class BaseLogger : ILogger`
`10`	`10`	`{`
`11`	`11`	`protected readonly ILoggerFormatter loggerFormatter;`
`12`	`12`
`@@ -43,5 +43,7 @@ public IDisposable BeginScope<T>(T state)`
`43`	`43`	`{`
`44`	`44`	`return null;`
`45`	`45`	`}`
	`46`	`+`
	`47`	`+ public abstract void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter);`
`46`	`48`	`}`
`47`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public HECJsonLogger(string categoryName, LogLevel threshold, HttpClient httpCli`
`32`	`32`	`/// <param name="state">Log object state.</param>`
`33`	`33`	`/// <param name="exception">Log Exception.</param>`
`34`	`34`	`/// <param name="formatter">Log text formatter function.</param>`
`35`		`- public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
	`35`	`+ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
`36`	`36`	`{`
`37`	`37`	`SplunkJSONEntry formatedMessage = null;`
`38`	`38`	`if (loggerFormatter != null)`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public HECRawLogger(string categoryName, LogLevel threshold, HttpClient httpClie`
`31`	`31`	`/// <param name="state">Log object state.</param>`
`32`	`32`	`/// <param name="exception">Log Exception.</param>`
`33`	`33`	`/// <param name="formatter">Log text formatter function.</param>`
`34`		`- public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
	`34`	`+ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
`35`	`35`	`{`
`36`	`36`	`string formatedMessage = string.Empty;`
`37`	`37`	`if (loggerFormatter != null)`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public TcpLogger(string categoryName, LogLevel threshold, TcpClient tcpClient, I`
`34`	`34`	`/// <param name="state">Log object state.</param>`
`35`	`35`	`/// <param name="exception">Log Exception.</param>`
`36`	`36`	`/// <param name="formatter">Log text formatter function.</param>`
`37`		`- public void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
	`37`	`+ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Exception exception, Func<T, Exception, string> formatter)`
`38`	`38`	`{`
`39`	`39`	`string formatedMessage = string.Empty;`
`40`	`40`	`if (loggerFormatter != null)`