Add logging of web server events

Configuration:
{ "logLevel": "Warning" }

Author: mxtsdev

ArkBot/Modules/Application/Configuration/Model/Config.cs

@@ -150,10 +150,17 @@ public void SetupDefaults()
 
         // Debugging, Logging etc.
 
+        [JsonProperty(PropertyName = "logLevel")]
+        [Display(Name = "Log Level", Description = "Log level")]
+        [DefaultValue(Microsoft.Extensions.Logging.LogLevel.Warning)]
+        [Category(ConfigurationCategory.Debug)]
+        [PropertyOrder(1)]
+        public Microsoft.Extensions.Logging.LogLevel LogLevel { get; set; }
+
         [JsonProperty(PropertyName = "anonymizeWebApiData")]
         [Display(Name = "Anonymize Web API Data", Description = "Anonymize all data in the WebAPI. Used to create data dumps for demoing the web-app")]
         [Category(ConfigurationCategory.Debug)]
-        [PropertyOrder(1)]
+        [PropertyOrder(2)]
         public bool AnonymizeWebApiData { get; set; }
 
         //[JsonProperty(PropertyName = "test")]

ArkBot/Modules/Application/Configuration/Model/IConfig.cs

@@ -14,6 +14,7 @@ public interface IConfig
         ClustersConfigSection Clusters { get; set; }
         string PowershellFilePath { get; set; }
         bool UseCompatibilityChangeWatcher { get; set; }
+        Microsoft.Extensions.Logging.LogLevel LogLevel { get; set; }
         bool AnonymizeWebApiData { get; set; }
 
         //Test1ConfigSection Test { get; set; }

ArkBot/Modules/Application/ViewModel/Workspace.cs

@@ -236,10 +236,6 @@ static void WriteAndWaitForKey(params string[] msgs)
 
         internal async Task Init()
         {
-            System.Console.WriteLine("ARK Bot");
-            System.Console.WriteLine("------------------------------------------------------");
-            System.Console.WriteLine();
-
             var logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
             XmlConfigurator.Configure(logRepository, new FileInfo("App.config")); //"log4net.config"
 
@@ -578,10 +574,7 @@ internal async Task Init()
                                     {
                                         logging.ClearProviders();
                                         logging.AddDebug();
-                                        logging.AddEventLog();
-                                        logging.AddEventSourceLogger();
-                                        //todo: add log4net logging
-                                        //possible to catch exceptions and serialize detailed exception logs?
+                                        logging.AddWebApp();
                                     })
                                     .UseUrls(_config.WebApp.Ssl.ChallengeListenPrefix)
                                     .Configure((appBuilder) =>
@@ -690,8 +683,7 @@ internal async Task Init()
                             {
                                 logging.ClearProviders();
                                 logging.AddDebug();
-                                logging.AddEventLog();
-                                logging.AddEventSourceLogger();
+                                logging.AddWebApp();
                             })
                             .UseContentRoot(Path.Combine(AppContext.BaseDirectory, "WebApp")) //Directory.GetCurrentDirectory()
                             .UseWebRoot(Path.Combine(AppContext.BaseDirectory, "WebApp"))

ArkBot/Modules/WebApp/WebAppLogger.cs

@@ -0,0 +1,114 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Logging;
+
+namespace ArkBot.Modules.WebApp
+{
+    public static class WebAppLoggerFactoryExtensions
+    {
+        public static ILoggingBuilder AddWebApp(this ILoggingBuilder builder)
+        {
+            builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, WebAppLoggerProvider>());
+
+            return builder;
+        }
+    }
+
+    [ProviderAlias("WebApp")]
+    public sealed class WebAppLoggerProvider : ILoggerProvider
+    {
+        private readonly Application.Configuration.Model.IConfig _config;
+
+        public WebAppLoggerProvider(Application.Configuration.Model.IConfig config)
+        {
+            _config = config;
+        }
+
+        public ILogger CreateLogger(string name)
+        {
+            return new WebAppLogger(name, _config);
+        }
+
+        public void Dispose() { }
+    }
+
+    public sealed class NullScope : IDisposable
+    {
+        public static NullScope Instance { get; } = new NullScope();
+
+        private NullScope() { }
+
+        public void Dispose() { }
+    }
+
+    internal class WebAppLogger : ILogger
+    {
+        private readonly Application.Configuration.Model.IConfig _config;
+        private readonly string _name;
+
+        private static Dictionary<LogLevel, ArkBot.Utils.LogLevel> _logLevels;
+
+        static WebAppLogger()
+        {
+            _logLevels = new Dictionary<LogLevel, Utils.LogLevel>
+            {
+                { LogLevel.Information, Utils.LogLevel.INFO },
+                { LogLevel.Warning, Utils.LogLevel.WARN },
+                { LogLevel.Error, Utils.LogLevel.ERROR },
+                { LogLevel.Critical, Utils.LogLevel.FATAL },
+                { LogLevel.Debug, Utils.LogLevel.DEBUG },
+                { LogLevel.Trace, Utils.LogLevel.DEBUG }
+            };
+        }
+
+        public WebAppLogger(string name, Application.Configuration.Model.IConfig config)
+        {
+            _name = name;
+            _config = config;
+        }
+
+        public IDisposable BeginScope<TState>(TState state)
+        {
+            return NullScope.Instance;
+        }
+
+        public bool IsEnabled(LogLevel logLevel)
+        {
+            if (logLevel == LogLevel.None) return false;
+
+            return logLevel >= (_config?.LogLevel ?? LogLevel.Warning);
+        }
+
+        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
+        {
+            if (!IsEnabled(logLevel)) return;
+
+            if (formatter == null)
+            {
+                throw new ArgumentNullException(nameof(formatter));
+            }
+
+            var message = formatter(state, exception);
+
+            if (string.IsNullOrEmpty(message))
+            {
+                return;
+            }
+
+            if (exception != null)
+            {
+                if (!_logLevels.TryGetValue(logLevel, out var internalLogLevel)) internalLogLevel = Utils.LogLevel.INFO;
+
+                Application.ViewModel.Workspace.Instance.Console.AddLog(@$"{message} (""{exception.Message}"")");
+                Utils.Logging.LogException(message, exception, GetType(), internalLogLevel);
+            }
+            else
+            {
+                Application.ViewModel.Workspace.Instance.Console.AddLog(message);
+            }
+        }
+    }
+}

ArkBot/defaultconfig.json

@@ -167,5 +167,6 @@
   "tempFileOutputDirPath": "",
   "powershellFilePath": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
   "useCompatibilityChangeWatcher": true,
+  "logLevel": "Warning",
   "anonymizeWebApiData": false
 }