Changed pipeline to use category name at log messages

#58

Author: Caldas

src/SplunkLogger/Configurations/HECConfiguration.cs

@@ -16,7 +16,7 @@ public enum ChannelIdOption
         /// <summary>
         /// Gets or sets the batch interval in milliseconds.
         /// </summary>
-        public uint BatchIntervalInMilliseconds { get; set; }
+        public int BatchIntervalInMilliseconds { get; set; }
 
         /// <summary>
         /// Gets or sets the batch size count.

src/SplunkLogger/ILoggerFormatter.cs

@@ -12,22 +12,24 @@ public interface ILoggerFormatter
         /// Format the specified logLevel, eventId, state and exception into log string entry.
         /// </summary>
         /// <returns>Formatted log string.</returns>
+        /// <param name="categoryName">Log category name.</param>
         /// <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>
-        string Format<T>(LogLevel logLevel, EventId eventId, T state, Exception exception);
+        string Format<T>(string categoryName, LogLevel logLevel, EventId eventId, T state, Exception exception);
 
         /// <summary>
         /// Formats the specified logLevel, eventId, state and exception into json entry.
         /// </summary>
         /// <returns>The json.</returns>
+        /// <param name="categoryName">Log category name.</param>
         /// <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>
-        SplunkJSONEntry FormatJson<T>(LogLevel logLevel, EventId eventId, T state, Exception exception);
+        SplunkJSONEntry FormatJson<T>(string categoryName, LogLevel logLevel, EventId eventId, T state, Exception exception);
     }
 }

src/SplunkLogger/Loggers/BaseLogger.cs

@@ -9,8 +9,7 @@ namespace Splunk.Loggers
     public abstract class BaseLogger : ILogger
     {
         protected readonly ILoggerFormatter loggerFormatter;
-
-        readonly string categoryName;
+        protected readonly string categoryName;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="T:Splunk.Loggers.BaseLogger"/> class.

src/SplunkLogger/Loggers/HECJsonLogger.cs

@@ -35,7 +35,7 @@ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Excepti
         {
             SplunkJSONEntry formatedMessage = null;
             if (loggerFormatter != null)
-                formatedMessage = loggerFormatter.FormatJson(logLevel, eventId, state, exception);
+                formatedMessage = loggerFormatter.FormatJson(categoryName, logLevel, eventId, state, exception);
             else if (formatter != null)
                 formatedMessage = new SplunkJSONEntry(formatter(state, exception));
             batchManager.Add(JObject.FromObject(formatedMessage));

src/SplunkLogger/Loggers/HECRawLogger.cs

@@ -34,7 +34,7 @@ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Excepti
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
-                formatedMessage = loggerFormatter.Format(logLevel, eventId, state, exception);
+                formatedMessage = loggerFormatter.Format(categoryName, logLevel, eventId, state, exception);
             else if (formatter != null)
                 formatedMessage = formatter(state, exception);
 

src/SplunkLogger/Loggers/TcpLogger.cs

@@ -37,7 +37,7 @@ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Excepti
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
-                formatedMessage = loggerFormatter.Format(logLevel, eventId, state, exception);
+                formatedMessage = loggerFormatter.Format(categoryName, logLevel, eventId, state, exception);
             else if (formatter != null)
                 formatedMessage = formatter(state, exception);
 

src/SplunkLogger/Loggers/UdpLogger.cs

@@ -37,7 +37,7 @@ public override void Log<T>(LogLevel logLevel, EventId eventId, T state, Excepti
         {
             string formatedMessage = string.Empty;
             if (loggerFormatter != null)
-                formatedMessage = loggerFormatter.Format(logLevel, eventId, state, exception);
+                formatedMessage = loggerFormatter.Format(categoryName, logLevel, eventId, state, exception);
             else if (formatter != null)
                 formatedMessage = formatter(state, exception);
 

src/SplunkLogger/Providers/SplunkHECBaseProvider.cs

@@ -13,8 +13,14 @@ namespace Splunk.Providers
     /// </summary>
     public abstract class SplunkHECBaseProvider : ILoggerProvider
     {
+        protected ILogger loggerInstance;
         protected HttpClient httpClient;
 
+        public SplunkHECBaseProvider(SplunkLoggerConfiguration configuration, string endPointCustomization)
+        {
+            SetupHttpClient(configuration, endPointCustomization);
+        }
+
         /// <summary>
         /// Get a <see cref="T:Splunk.Loggers.HECJsonLogger"/> instance to the category name provided.
         /// </summary>
@@ -33,14 +39,7 @@ public abstract class SplunkHECBaseProvider : ILoggerProvider
         /// that the <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> was occupying.</remarks>
         public abstract void Dispose();
 
-        /// <summary>
-        /// Create a <see cref="T:Splunk.Loggers.HECJsonLogger"/> instance to the category name provided.
-        /// </summary>
-        /// <returns>The logger instance.</returns>
-        /// <param name="categoryName">Category name.</param>
-        public abstract ILogger CreateLoggerInstance(string categoryName);
-
-        protected void SetupHttpClient(SplunkLoggerConfiguration configuration, string endPointCustomization)
+        void SetupHttpClient(SplunkLoggerConfiguration configuration, string endPointCustomization)
         {
             httpClient = new HttpClient
             {
@@ -55,69 +54,69 @@ protected void SetupHttpClient(SplunkLoggerConfiguration configuration, string e
                 httpClient.DefaultRequestHeaders.Add("x-splunk-request-channel", Guid.NewGuid().ToString());
         }
 
-        Uri GetSplunkCollectorUrl(SplunkLoggerConfiguration configuration, string endPointCustomization)
-        {
-            var splunkCollectorUrl = configuration.HecConfiguration.SplunkCollectorUrl;
-            if (!splunkCollectorUrl.EndsWith("/", StringComparison.InvariantCulture))
-                splunkCollectorUrl = splunkCollectorUrl + "/";
-
-            if(!string.IsNullOrWhiteSpace(endPointCustomization))
-                splunkCollectorUrl = splunkCollectorUrl + endPointCustomization;
-
-            if (configuration.HecConfiguration.ChannelIdType == HECConfiguration.ChannelIdOption.QueryString)
-                splunkCollectorUrl = splunkCollectorUrl + "?channel=" + Guid.NewGuid().ToString();
-
-            if(configuration.HecConfiguration.UseAuthTokenAsQueryString)
-            {
-                var tokenParameter = "token=" + configuration.HecConfiguration.Token;
-                splunkCollectorUrl = string.Format("{0}{1}{2}", splunkCollectorUrl, splunkCollectorUrl.Contains("?") ? "&" : "?", tokenParameter);
-            }
-
-            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.");
+                        Debug.WriteLine($"[DEBUG] Splunk HEC {loggerType} Status: Request completed successfully.");
                         break;
                     case System.Net.HttpStatusCode.Created:
-                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Create request completed successfully.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] Splunk HEC {loggerType} Status: Insufficient permission.");
                         break;
                     case System.Net.HttpStatusCode.NotFound:
-                        Debug.WriteLine($"Splunk HEC {loggerType} Status: Requested endpoint does not exist.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] 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.");
+                        Debug.WriteLine($"[DEBUG] Splunk HEC {loggerType} Status: Feature is disabled in configuration file.");
                         break;
-                }
+                }
             }
             else if (responseMessageTask.IsCanceled)
-                Debug.WriteLine($"Splunk HEC {loggerType} Status: Canceled");
+                Debug.WriteLine($"[DEBUG] Splunk HEC {loggerType} Status: Canceled");
             else
-                Debug.WriteLine($"Splunk HEC {loggerType} Status: Error " + responseMessageTask.Exception != null ? responseMessageTask.Exception.ToString() : "");
+                Debug.WriteLine($"[DEBUG] Splunk HEC {loggerType} Status: Error " + responseMessageTask.Exception != null ? responseMessageTask.Exception.ToString() : "");
+        }
+
+        Uri GetSplunkCollectorUrl(SplunkLoggerConfiguration configuration, string endPointCustomization)
+        {
+            var splunkCollectorUrl = configuration.HecConfiguration.SplunkCollectorUrl;
+            if (!splunkCollectorUrl.EndsWith("/", StringComparison.InvariantCulture))
+                splunkCollectorUrl = splunkCollectorUrl + "/";
+
+            if(!string.IsNullOrWhiteSpace(endPointCustomization))
+                splunkCollectorUrl = splunkCollectorUrl + endPointCustomization;
+
+            if (configuration.HecConfiguration.ChannelIdType == HECConfiguration.ChannelIdOption.QueryString)
+                splunkCollectorUrl = splunkCollectorUrl + "?channel=" + Guid.NewGuid().ToString();
+
+            if(configuration.HecConfiguration.UseAuthTokenAsQueryString)
+            {
+                var tokenParameter = "token=" + configuration.HecConfiguration.Token;
+                splunkCollectorUrl = string.Format("{0}{1}{2}", splunkCollectorUrl, splunkCollectorUrl.Contains("?") ? "&" : "?", tokenParameter);
+            }
+
+            return new Uri(splunkCollectorUrl);
         }
     }
 }

src/SplunkLogger/Providers/SplunkHECJsonLoggerProvider.cs

@@ -1,4 +1,4 @@
-using System.Collections.Concurrent;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net.Http;
@@ -15,7 +15,7 @@ namespace Splunk.Providers
     /// </summary>
     public class SplunkHECJsonLoggerProvider : SplunkHECBaseProvider, ILoggerProvider
     {
-        readonly BatchManager batchController;
+        readonly BatchManager batchManager;
         readonly ILoggerFormatter loggerFormatter;
         readonly ConcurrentDictionary<string, ILogger> loggers;
 
@@ -25,49 +25,36 @@ public class SplunkHECJsonLoggerProvider : SplunkHECBaseProvider, ILoggerProvide
         /// <param name="configuration">Splunk configuration instance for HEC.</param>
         /// <param name="loggerFormatter">Formatter instance.</param>
         public SplunkHECJsonLoggerProvider(SplunkLoggerConfiguration configuration, ILoggerFormatter loggerFormatter = null)
+            : base(configuration, "event")
         {
-            loggers = new ConcurrentDictionary<string, ILogger>();
-
             this.loggerFormatter = loggerFormatter;
-
-            SetupHttpClient(configuration, "event");
-
-            batchController = new BatchManager(configuration.HecConfiguration.BatchSizeCount, configuration.HecConfiguration.BatchIntervalInMilliseconds, Emit);
-        }
-
-        /// <summary>
-        /// Get a <see cref="T:Splunk.Loggers.HECJsonLogger"/> instance to the category name provided.
-        /// </summary>
-        /// <returns><see cref="T:Splunk.Loggers.HECJsonLogger"/> instance.</returns>
-        /// <param name="categoryName">Category name.</param>
-        public override ILogger CreateLogger(string categoryName)
-        {
-            return loggers.GetOrAdd(categoryName, CreateLoggerInstance(categoryName));
-        }
-
-        /// <summary>
-        /// Releases all resource used by the <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> object.
-        /// </summary>
-        /// <remarks>Call <see cref="Dispose"/> when you are finished using the
-        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/>. The <see cref="Dispose"/> method leaves the
-        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> in an unusable state. After calling
-        /// <see cref="Dispose"/>, you must release all references to the
-        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> so the garbage collector can reclaim the memory
-        /// that the <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> was occupying.</remarks>
-        public override void Dispose()
-        {
-            loggers.Clear();
-        }
-
-        /// <summary>
-        /// Create a <see cref="T:Splunk.Loggers.HECJsonLogger"/> instance to the category name provided.
-        /// </summary>
-        /// <returns>The logger instance.</returns>
-        /// <param name="categoryName">Category name.</param>
-        public override ILogger CreateLoggerInstance(string categoryName)
-        {
-            return new HECJsonLogger(categoryName, httpClient, batchController, loggerFormatter);
+            loggers = new ConcurrentDictionary<string, ILogger>();
+            batchManager = new BatchManager(configuration.HecConfiguration.BatchSizeCount, configuration.HecConfiguration.BatchIntervalInMilliseconds, Emit);
         }
+
+        /// <summary>
+        /// Get a <see cref="T:Splunk.Loggers.HECJsonLogger"/> instance to the category name provided.
+        /// </summary>
+        /// <returns><see cref="T:Splunk.Loggers.HECJsonLogger"/> instance.</returns>
+        /// <param name="categoryName">Category name.</param>
+        public override ILogger CreateLogger(string categoryName)
+        {
+            return loggers.GetOrAdd(categoryName, CreateLoggerInstance(categoryName));
+        }
+
+        /// <summary>
+        /// Releases all resource used by the <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> object.
+        /// </summary>
+        /// <remarks>Call <see cref="Dispose"/> when you are finished using the
+        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/>. The <see cref="Dispose"/> method leaves the
+        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> in an unusable state. After calling
+        /// <see cref="Dispose"/>, you must release all references to the
+        /// <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> so the garbage collector can reclaim the memory
+        /// that the <see cref="T:Splunk.Providers.SplunkHECJsonLoggerProvider"/> was occupying.</remarks>
+        public override void Dispose()
+        {
+            loggers.Clear();
+        }
 
         /// <summary>
         /// Method used to emit batched events.
@@ -80,6 +67,11 @@ public void Emit(List<object> events)
             var stringContent = new StringContent(formatedMessage, Encoding.UTF8, "application/json");
             httpClient.PostAsync(string.Empty, stringContent)
                       .ContinueWith(task => DebugSplunkResponse(task, "json"));
+        }
+
+        ILogger CreateLoggerInstance(string categoryName)
+        {
+            return new HECJsonLogger(categoryName, httpClient, batchManager, loggerFormatter);
         }
     }
 }