Refactored VTEXSplunkLoggerFormatter and Startup classes to set formatter setup to inside the constructor and also improved code documentation

#14
#15

Author: Caldas

src/SampleWebAPI/Logging/VTEXSplunkLoggerFormatter.cs

@@ -1,23 +1,45 @@
 using System;
 using System.Linq;
+using System.Net.Http;
+using System.Threading;
 using Microsoft.Extensions.Logging;
 using Splunk;
 
 namespace VTEX.SampleWebAPI.Logging
 {
+    /// <summary>
+    /// This class contains all methods to format a Log event into a VTEX standard text.
+    /// </summary>
+    /// <remarks>
+    /// At our Splunk environment at VTEX we expect certain standard of text to be processed and
+    /// we also have field extraction rules to be applied.
+    /// Thats the reason why we use a custom LoggerFormmater.
+    /// </remarks>
     public class VTEXSplunkLoggerFormatter : ILoggerFormatter
     {
         const string DateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffZ";
 
         readonly string appVersion;
         readonly string host;
 
-        public VTEXSplunkLoggerFormatter(string appVersion, string host)
+        /// <summary>
+        /// Initializes a new instance of the <see cref="T:VTEX.SampleWebAPI.Logging.VTEXSplunkLoggerFormatter"/> class.
+        /// </summary>
+        public VTEXSplunkLoggerFormatter()
         {
-            this.appVersion = appVersion;
-            this.host = host;
+            appVersion = Microsoft.Extensions.PlatformAbstractions.PlatformServices.Default.Application.ApplicationVersion;
+            host = GetHost();
         }
 
+        /// <summary>
+        /// Format the specified logLevel, eventId, state and exception into log string entry.
+        /// </summary>
+        /// <returns>Formatted log string.</returns>
+        /// <param name="logLevel">Log level.</param>
+        /// <param name="eventId">Event identifier.</param>
+        /// <param name="state">Log object state.</param>
+        /// <param name="exception">Log exception.</param>
+        /// <typeparam name="T">Log entry.</typeparam>
         public string Format<T>(LogLevel logLevel, EventId eventId, T state, Exception exception)
         {
             string log;
@@ -46,11 +68,53 @@ public string Format<T>(LogLevel logLevel, EventId eventId, T state, Exception e
             return log;
         }
 
+        /// <summary>
+        /// Formats the specified logLevel, eventId, state and exception into json entry.
+        /// </summary>
+        /// <returns>The json.</returns>
+        /// <param name="logLevel">Log level.</param>
+        /// <param name="eventId">Event identifier.</param>
+        /// <param name="state">Log object state.</param>
+        /// <param name="exception">Log exception.</param>
+        /// <typeparam name="T">Log entry.</typeparam>
         public SplunkJSONEntry FormatJson<T>(LogLevel logLevel, EventId eventId, T state, Exception exception)
         {
             return new SplunkJSONEntry(Format(logLevel, eventId, state, exception), 0, host, string.Empty, "Log");
         }
 
+        /// <summary>
+        /// Method created to get AWS EC2 host Id, or set `dev` as host if AWS internal call fails.
+        /// </summary>
+        string GetHost()
+        {
+            string ec2Host = string.Empty;
+            try
+            {
+                using (HttpClient httpClient = new HttpClient())
+                {
+                    TimeSpan timeSpan = new TimeSpan(0, 0, 5);
+                    var cancellationTokenSource = new CancellationTokenSource((int)timeSpan.TotalMilliseconds);
+                    httpClient.Timeout = timeSpan;
+                    httpClient.BaseAddress = new Uri("http://169.254.169.254/latest/meta-data/");
+                    ec2Host = httpClient
+                        .GetAsync("instance-id", cancellationTokenSource.Token)
+                        .Result
+                        .Content
+                        .ReadAsStringAsync()
+                        .Result;
+                }
+            }
+            catch
+            {
+                ec2Host = "dev";
+            }
+            return ec2Host;
+        }
+
+        /// <summary>
+        /// Based on LogLevel we define the correspondent VTEX event level.
+        /// </summary>
+        /// <returns>VTEX event level.</returns>
         string GetVTEXEventLevel(LogLevel logLevel)
         {
             VTEXEventLevel eventLevel = VTEXEventLevel.Debug;
@@ -75,6 +139,10 @@ string GetVTEXEventLevel(LogLevel logLevel)
             return eventLevel.ToString().ToLower();
         }
 
+        /// <summary>
+        /// Based on LogLevel we define the correspondent VTEX log type.
+        /// </summary>
+        /// <returns>VTEX log type.</returns>
         string GetVTEXLogType(LogLevel logLevel)
         {
             VTEXLogType logType = VTEXLogType.Info;
@@ -97,4 +165,4 @@ string GetVTEXLogType(LogLevel logLevel)
             return logType.ToString().ToLower();
         }
     }
-}
+}

src/SampleWebAPI/Startup.cs

@@ -14,22 +14,30 @@ namespace VTEX.SampleWebAPI
 {
     public class Startup
     {
-        static readonly ILoggerFormatter formatter = new VTEXSplunkLoggerFormatter(Microsoft.Extensions.PlatformAbstractions.PlatformServices.Default.Application.ApplicationVersion, GetHost());
+        static readonly ILoggerFormatter formatter = new VTEXSplunkLoggerFormatter();
+
+        public IConfiguration Configuration { get; }
 
         public Startup(IConfiguration configuration)
         {
             Configuration = configuration;
         }
 
-        public IConfiguration Configuration { get; }
-
-        // This method gets called by the runtime. Use this method to add services to the container.
+        /// <summary>
+        /// This method gets called by the runtime. Use this method to add services to the container.
+        /// </summary>
         public void ConfigureServices(IServiceCollection services)
         {
             services.AddMvc();
         }
 
-        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        /// <summary>
+        /// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        /// </summary>
+        /// <returns>The configure.</returns>
+        /// <param name="app">App.</param>
+        /// <param name="env">Env.</param>
+        /// <param name="loggerFactory">Logger factory.</param>
         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
         {
             loggerFactory.AddDebug();
@@ -48,48 +56,25 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
                 }
             };
 
-            //loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, null);
-            loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, formatter);
+            /**************************** Define Your Logger ****************************/
+            /*                                                                          */
+            //loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, null);           //
+            loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, formatter);        //
 
-            //loggerFactory.AddHECJsonSplunkLogger(splunkConfiguration, null);
-            //loggerFactory.AddHECJsonSplunkLogger(splunkConfiguration, formatter);
+            //loggerFactory.AddHECJsonSplunkLogger(splunkConfiguration, null);          //
+            //loggerFactory.AddHECJsonSplunkLogger(splunkConfiguration, formatter);     //
 
-            //loggerFactory.AddTcpSplunkLogger(splunkConfiguration, null);
-            //loggerFactory.AddTcpSplunkLogger(splunkConfiguration, formatter);
+            //loggerFactory.AddTcpSplunkLogger(splunkConfiguration, null);              //
+            //loggerFactory.AddTcpSplunkLogger(splunkConfiguration, formatter);         //
 
             //loggerFactory.AddUdpSplunkLogger(splunkConfiguration, null);
             //loggerFactory.AddUdpSplunkLogger(splunkConfiguration, formatter);
+            /*                                                                          */
+            /**************************** Define Your Logger ****************************/
 
             app.UseMvc();
         }
 
-        /// <summary>
-        /// Method created to get AWS EC2 host Id, or set `dev` as host if AWS internal call fails.
-        /// </summary>
-        static string GetHost()
-        {
-            string host = string.Empty;
-            try
-            {
-                using (HttpClient httpClient = new HttpClient())
-                {
-                    TimeSpan timeSpan = new TimeSpan(0, 0, 5);
-                    var cancellationTokenSource = new CancellationTokenSource((int)timeSpan.TotalMilliseconds);
-                    httpClient.Timeout = timeSpan;
-                    httpClient.BaseAddress = new Uri("http://169.254.169.254/latest/meta-data/");
-                    host = httpClient
-                        .GetAsync("instance-id", cancellationTokenSource.Token)
-                        .Result
-                        .Content
-                        .ReadAsStringAsync()
-                        .Result;
-                }
-            }
-            catch
-            {
-                host = "dev";
-            }
-            return host;
-        }
+
     }
 }