V9: Display configured log levels (#11715)

* Adding ILogLevelLoader to get Serilog level values (global one and umbraco) and the corresponding dependencies

* Obsoleting old methods

* Fix tests

* Front-end changes

* Changes requested in a review

Author: elit0451

src/Umbraco.Infrastructure/DependencyInjection/UmbracoBuilder.CoreServices.cs

@@ -268,10 +268,12 @@ private static IUmbracoBuilder AddPreValueMigrators(this IUmbracoBuilder builder
         public static IUmbracoBuilder AddLogViewer(this IUmbracoBuilder builder)
         {
             builder.Services.AddSingleton<ILogViewerConfig, LogViewerConfig>();
+            builder.Services.AddSingleton<ILogLevelLoader, LogLevelLoader>();
             builder.SetLogViewer<SerilogJsonLogViewer>();
             builder.Services.AddSingleton<ILogViewer>(factory => new SerilogJsonLogViewer(factory.GetRequiredService<ILogger<SerilogJsonLogViewer>>(),
                 factory.GetRequiredService<ILogViewerConfig>(),
                 factory.GetRequiredService<ILoggingConfiguration>(),
+                factory.GetRequiredService<ILogLevelLoader>(),
                 Log.Logger));
 
             return builder;

src/Umbraco.Infrastructure/Logging/Serilog/LoggerConfigExtensions.cs

@@ -31,7 +31,8 @@ public static LoggerConfiguration MinimalConfiguration(
             this LoggerConfiguration logConfig,
             IHostingEnvironment hostingEnvironment,
             ILoggingConfiguration loggingConfiguration,
-            IConfiguration configuration)
+            IConfiguration configuration,
+            out UmbracoFileConfiguration umbFileConfiguration)
         {
             global::Serilog.Debugging.SelfLog.Enable(msg => System.Diagnostics.Debug.WriteLine(msg));
 
@@ -54,6 +55,8 @@ public static LoggerConfiguration MinimalConfiguration(
             //This is not optimal, but seems to be the only way if we do not make an Serilog.Sink.UmbracoFile sink all the way.
             var umbracoFileConfiguration = new UmbracoFileConfiguration(configuration);
 
+            umbFileConfiguration = umbracoFileConfiguration;
+
             logConfig.WriteTo.UmbracoFile(
                 path : umbracoFileConfiguration.GetPath(loggingConfiguration.LogDirectory),
                 fileSizeLimitBytes: umbracoFileConfiguration.FileSizeLimitBytes,

src/Umbraco.Infrastructure/Logging/Serilog/SerilogLogger.cs

@@ -3,6 +3,7 @@
 using Serilog;
 using Serilog.Events;
 using Umbraco.Cms.Core.Hosting;
+using Umbraco.Cms.Infrastructure.Logging.Serilog;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.Logging.Serilog
@@ -27,13 +28,14 @@ public SerilogLogger(LoggerConfiguration logConfig)
         public static SerilogLogger CreateWithDefaultConfiguration(
             IHostingEnvironment hostingEnvironment,
             ILoggingConfiguration loggingConfiguration,
-            IConfiguration configuration)
+            IConfiguration configuration,
+            out UmbracoFileConfiguration umbracoFileConfig)
         {
-            var loggerConfig = new LoggerConfiguration()
-                .MinimalConfiguration(hostingEnvironment, loggingConfiguration, configuration)
+            var serilogConfig = new LoggerConfiguration()
+                .MinimalConfiguration(hostingEnvironment, loggingConfiguration, configuration, out umbracoFileConfig)
                 .ReadFrom.Configuration(configuration);
 
-            return new SerilogLogger(loggerConfig);
+            return new SerilogLogger(serilogConfig);
         }
 
         /// <summary>

src/Umbraco.Infrastructure/Logging/Viewer/ILogLevelLoader.cs

@@ -0,0 +1,18 @@
+using System.Collections.ObjectModel;
+using Serilog.Events;
+
+namespace Umbraco.Cms.Core.Logging.Viewer
+{
+    public interface ILogLevelLoader
+    {
+        /// <summary>
+        /// Get the Serilog level values of the global minimum and the UmbracoFile one from the config file.
+        /// </summary>
+        ReadOnlyDictionary<string, LogEventLevel> GetLogLevelsFromSinks();
+
+        /// <summary>
+        /// Get the Serilog minimum-level value from the config file.
+        /// </summary>
+        LogEventLevel GetGlobalMinLogLevel();
+    }
+}

src/Umbraco.Infrastructure/Logging/Viewer/ILogViewer.cs

@@ -1,4 +1,7 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Serilog.Events;
 using Umbraco.Cms.Core.Models;
 
 namespace Umbraco.Cms.Core.Logging.Viewer
@@ -40,10 +43,16 @@ public interface ILogViewer
 
         bool CheckCanOpenLogs(LogTimePeriod logTimePeriod);
 
+        /// <summary>
+        /// Get the Serilog minimum-level and UmbracoFile-level values from the config file.
+        /// </summary>
+        ReadOnlyDictionary<string, LogEventLevel> GetLogLevels();
+
         /// <summary>
         /// Gets the current Serilog minimum log level
         /// </summary>
         /// <returns></returns>
+        [Obsolete("Please use GetLogLevels() instead. Scheduled for removal in V11.")]
         string GetLogLevel();
 
         /// <summary>

src/Umbraco.Infrastructure/Logging/Viewer/LogLevelLoader.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Text;
+using Serilog;
+using Serilog.Events;
+using Umbraco.Cms.Infrastructure.Logging.Serilog;
+
+namespace Umbraco.Cms.Core.Logging.Viewer
+{
+    public class LogLevelLoader : ILogLevelLoader
+    {
+        private readonly UmbracoFileConfiguration _umbracoFileConfig;
+
+        public LogLevelLoader(UmbracoFileConfiguration umbracoFileConfig) => _umbracoFileConfig = umbracoFileConfig;
+
+        /// <summary>
+        /// Get the Serilog level values of the global minimum and the UmbracoFile one from the config file.
+        /// </summary>
+        public ReadOnlyDictionary<string, LogEventLevel> GetLogLevelsFromSinks()
+        {
+            var configuredLogLevels = new Dictionary<string, LogEventLevel>
+            {
+                { "Global", GetGlobalMinLogLevel() },
+                { "UmbracoFile", _umbracoFileConfig.RestrictedToMinimumLevel }
+            };
+
+            return new ReadOnlyDictionary<string, LogEventLevel>(configuredLogLevels);
+        }
+
+        /// <summary>
+        /// Get the Serilog minimum-level value from the config file.
+        /// </summary>
+        public LogEventLevel GetGlobalMinLogLevel()
+        {
+            var logLevel = Enum.GetValues(typeof(LogEventLevel)).Cast<LogEventLevel>().Where(Log.IsEnabled).DefaultIfEmpty(LogEventLevel.Information)?.Min() ?? null;
+            return (LogEventLevel)logLevel;
+        }
+    }
+}

src/Umbraco.Infrastructure/Logging/Viewer/SerilogJsonLogViewer.cs

@@ -1,12 +1,11 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 using Serilog.Events;
 using Serilog.Formatting.Compact.Reader;
-using Umbraco.Cms.Core.Logging;
 
 namespace Umbraco.Cms.Core.Logging.Viewer
 {
@@ -19,8 +18,9 @@ public SerilogJsonLogViewer(
             ILogger<SerilogJsonLogViewer> logger,
             ILogViewerConfig logViewerConfig,
             ILoggingConfiguration loggingConfiguration,
+            ILogLevelLoader logLevelLoader,
             global::Serilog.ILogger serilogLog)
-            : base(logViewerConfig, serilogLog)
+            : base(logViewerConfig, logLevelLoader, serilogLog)
         {
             _logger = logger;
             _logsPath = loggingConfiguration.LogDirectory;

src/Umbraco.Infrastructure/Logging/Viewer/SerilogLogViewerSourceBase.cs

@@ -1,20 +1,33 @@
-using System;
+using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Linq;
+using Microsoft.Extensions.DependencyInjection;
 using Serilog.Events;
 using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Web.Common.DependencyInjection;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.Logging.Viewer
 {
     public abstract class SerilogLogViewerSourceBase : ILogViewer
     {
         private readonly ILogViewerConfig _logViewerConfig;
+        private readonly ILogLevelLoader _logLevelLoader;
         private readonly global::Serilog.ILogger _serilogLog;
 
+        [Obsolete("Please use ctor with all params instead. Scheduled for removal in V11.")]
         protected SerilogLogViewerSourceBase(ILogViewerConfig logViewerConfig, global::Serilog.ILogger serilogLog)
         {
             _logViewerConfig = logViewerConfig;
+            _logLevelLoader = StaticServiceProvider.Instance.GetRequiredService<ILogLevelLoader>();
+            _serilogLog = serilogLog;
+        }
+
+        protected SerilogLogViewerSourceBase(ILogViewerConfig logViewerConfig, ILogLevelLoader logLevelLoader, global::Serilog.ILogger serilogLog)
+        {
+            _logViewerConfig = logViewerConfig;
+            _logLevelLoader = logLevelLoader;
             _serilogLog = serilogLog;
         }
 
@@ -43,14 +56,22 @@ public int GetNumberOfErrors(LogTimePeriod logTimePeriod)
             return errorCounter.Count;
         }
 
+        /// <summary>
+        /// Get the Serilog minimum-level and UmbracoFile-level values from the config file.
+        /// </summary>
+        public ReadOnlyDictionary<string, LogEventLevel> GetLogLevels()
+        {
+            return _logLevelLoader.GetLogLevelsFromSinks();
+        }
+
         /// <summary>
         /// Get the Serilog minimum-level value from the config file.
         /// </summary>
-        /// <returns></returns>
+        [Obsolete("Please use LogLevelLoader.GetGlobalMinLogLevel() instead. Scheduled for removal in V11.")]
         public string GetLogLevel()
         {
             var logLevel = Enum.GetValues(typeof(LogEventLevel)).Cast<LogEventLevel>().Where(_serilogLog.IsEnabled).DefaultIfEmpty(LogEventLevel.Information)?.Min() ?? null;
-            return logLevel?.ToString() ?? "";
+            return logLevel?.ToString() ?? string.Empty;
         }
 
         public LogLevelCounts GetLogLevelCounts(LogTimePeriod logTimePeriod)
@@ -129,7 +150,5 @@ public PagedResult<LogMessage> GetLogs(LogTimePeriod logTimePeriod,
                 Items = logMessages
             };
         }
-
-
     }
 }

src/Umbraco.Web.BackOffice/Controllers/LogViewerController.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
+using Serilog.Events;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.Logging.Viewer;
 using Umbraco.Cms.Core.Models;
@@ -135,6 +137,13 @@ public IEnumerable<SavedLogSearch> DeleteSavedSearch(SavedLogSearch item)
             return _logViewer.DeleteSavedSearch(item.Name, item.Query);
         }
 
+        [HttpGet]
+        public ReadOnlyDictionary<string, LogEventLevel> GetLogLevels()
+        {
+            return _logViewer.GetLogLevels();
+        }
+
+        [Obsolete("Please use GetLogLevels() instead. Scheduled for removal in V11.")]
         [HttpGet]
         public string GetLogLevel()
         {

src/Umbraco.Web.Common/Extensions/ServiceCollectionExtensions.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.Reflection;
 using Microsoft.AspNetCore.Hosting;
@@ -29,7 +30,8 @@ public static IServiceCollection AddLogger(
             IConfiguration configuration)
         {
             // Create a serilog logger
-            var logger = SerilogLogger.CreateWithDefaultConfiguration(hostingEnvironment, loggingConfiguration, configuration);
+            var logger = SerilogLogger.CreateWithDefaultConfiguration(hostingEnvironment, loggingConfiguration, configuration, out var umbracoFileConfig);
+            services.AddSingleton(umbracoFileConfig);
 
             // This is nessasary to pick up all the loggins to MS ILogger.
             Log.Logger = logger.SerilogLog;