structured logging

2019-10-22 11:57:28 -04:00
parent ce25967633
commit 2e3a4efb74
79 changed files with 891 additions and 497 deletions
--- a/Oqtane.Server/Infrastructure/ILogManager.cs
+++ b/Oqtane.Server/Infrastructure/ILogManager.cs
@ -0,0 +1,13 @@
+using Oqtane.Models;
+using Oqtane.Shared;
+using System;
+
+namespace Oqtane.Infrastructure
+{
+    public interface ILogManager
+    {
+        void AddLog(string Category, LogLevel Level, string Message, params object[] Args);
+        void AddLog(string Category, LogLevel Level, Exception Exception, string Message, params object[] Args);
+        void AddLog(Log Log);
+    }
+}
--- a/Oqtane.Server/Infrastructure/LogManager.cs
+++ b/Oqtane.Server/Infrastructure/LogManager.cs
@ -0,0 +1,128 @@
+using Oqtane.Shared;
+using System;
+using Oqtane.Models;
+using System.Text.Json;
+using Oqtane.Repository;
+using Microsoft.Extensions.Configuration;
+using Microsoft.AspNetCore.Http;
+using System.Security.Claims;
+using System.Collections.Generic;
+
+namespace Oqtane.Infrastructure
+{
+    public class LogManager : ILogManager
+    {
+        private readonly ILogRepository Logs;
+        private readonly ITenantResolver TenantResolver;
+        private readonly IConfigurationRoot Config;
+        private readonly IHttpContextAccessor Accessor;
+
+        public LogManager(ILogRepository Logs, ITenantResolver TenantResolver, IConfigurationRoot Config, IHttpContextAccessor Accessor)
+        {
+            this.Logs = Logs;
+            this.TenantResolver = TenantResolver;
+            this.Config = Config;
+            this.Accessor = Accessor;
+        }
+
+        public void AddLog(string Category, LogLevel Level, string Message, params object[] Args)
+        {
+            AddLog(Category, Level, null, Message, Args);
+        }
+
+        public void AddLog(string Category, LogLevel Level, Exception Exception, string Message, params object[] Args)
+        {
+            Alias alias = TenantResolver.GetAlias();
+            Log log = new Log();
+            log.SiteId = alias.SiteId;
+            log.PageId = null;
+            log.ModuleId = null;
+            if (Accessor.HttpContext.User.FindFirst(ClaimTypes.PrimarySid) != null)
+            {
+                log.UserId = int.Parse(Accessor.HttpContext.User.FindFirst(ClaimTypes.PrimarySid).Value);
+            }
+            HttpRequest request = Accessor.HttpContext.Request;
+            if (request != null)
+            {
+                log.Url = request.Scheme.ToString() + "://" + request.Host.ToString() + request.Path.ToString() + request.QueryString.ToString();
+            }
+
+            log.Category = Category;
+            log.Level = Enum.GetName(typeof(LogLevel), Level);
+            if (Exception != null)
+            {
+                log.Exception = JsonSerializer.Serialize(Exception);
+            }
+            log.Message = Message;
+            log.MessageTemplate = "";
+            log.Properties = JsonSerializer.Serialize(Args);
+            AddLog(log);
+        }
+
+        public void AddLog(Log Log)
+        {
+            LogLevel minlevel = LogLevel.Information;
+            var section = Config.GetSection("Logging:LogLevel:Default");
+            if (section.Exists())
+            {
+                minlevel = Enum.Parse<LogLevel>(Config.GetSection("Logging:LogLevel:Default").ToString());
+            }
+
+            if (Enum.Parse<LogLevel>(Log.Level) >= minlevel)
+            {
+                Log.LogDate = DateTime.UtcNow;
+                Log.Server = Environment.MachineName;
+                Log.MessageTemplate = Log.Message;
+                Log = ProcessStructuredLog(Log);
+                Logs.AddLog(Log);
+            }
+        }
+
+        private Log ProcessStructuredLog(Log Log)
+        {
+            string message = Log.Message;
+            string properties = "";
+            if (!string.IsNullOrEmpty(message) && message.Contains("{") && message.Contains("}") && !string.IsNullOrEmpty(Log.Properties))
+            {
+                // get the named holes in the message and replace values
+                object[] values = JsonSerializer.Deserialize<object[]>(Log.Properties);
+                List<string> names = new List<string>();
+                int index = message.IndexOf("{");
+                while (index != -1)
+                {
+                    if (message.IndexOf("}", index) != -1)
+                    {
+                        names.Add(message.Substring(index + 1, message.IndexOf("}", index) - index - 1));
+                        if (values.Length > (names.Count - 1))
+                        {
+                            message = message.Replace("{" + names[names.Count - 1] + "}", values[names.Count - 1].ToString());
+                        }
+                    }
+                    index = message.IndexOf("{", index + 1);
+                }
+                // rebuild properties into dictionary
+                Dictionary<string, string> propertydictionary = new Dictionary<string, string>();
+                for (int i = 0; i < values.Length; i++)
+                {
+                    string value = "";
+                    if (values[i] != null)
+                    {
+                        value = values[i].ToString();
+                    }
+                    if (i < names.Count)
+                    {
+                        propertydictionary.Add(names[i], value);
+                    }
+                    else
+                    {
+                        propertydictionary.Add("Property" + i.ToString(), value);
+                    }
+                }
+                properties = JsonSerializer.Serialize(propertydictionary);
+            }
+            Log.Message = message;
+            Log.Properties = properties;
+            return Log;
+        }
+    }
+}