| | | 1 | | using System.Collections.Concurrent; |
| | | 2 | | using Serilog; |
| | | 3 | | using Serilog.Core; |
| | | 4 | | using Serilog.Events; |
| | | 5 | | |
| | | 6 | | namespace Kestrun.Logging; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Manages a collection of named Serilog loggers and their configurations. |
| | | 10 | | /// </summary> |
| | | 11 | | public static class LoggerManager |
| | | 12 | | { |
| | 1 | 13 | | private static readonly ConcurrentDictionary<string, Serilog.ILogger> _loggers = new(StringComparer.OrdinalIgnoreCas |
| | 1 | 14 | | private static readonly ConcurrentDictionary<string, LoggerConfiguration> _configs = new(StringComparer.OrdinalIgnor |
| | | 15 | | // Synchronization object to guard global default logger transitions and coordinated disposal |
| | | 16 | | #if NET9_0_OR_GREATER |
| | 1 | 17 | | private static readonly Lock _sync = new(); |
| | | 18 | | #else |
| | | 19 | | private static readonly object _sync = new(); |
| | | 20 | | #endif |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// A collection of named logging level switches for dynamic log level control. |
| | | 24 | | /// </summary> |
| | 1 | 25 | | private static readonly ConcurrentDictionary<string, LoggingLevelSwitch> _switches = new(StringComparer.OrdinalIgnor |
| | | 26 | | |
| | | 27 | | internal static LoggingLevelSwitch EnsureSwitch(string name, LogEventLevel initial = LogEventLevel.Information) |
| | 11 | 28 | | => _switches.GetOrAdd(name, _ => new LoggingLevelSwitch(initial)); |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Register an existing Serilog logger instance under a name. |
| | | 32 | | /// </summary> |
| | | 33 | | /// <param name="name">The name of the logger.</param> |
| | | 34 | | /// <param name="logger">The logger instance to register.</param> |
| | | 35 | | /// <param name="setAsDefault">If true, sets the registered logger as the Serilog default logger.</param> |
| | | 36 | | /// <param name="levelSwitch">An optional logging level switch to associate with the logger for dynamic level contro |
| | | 37 | | /// <returns>The registered logger instance.</returns> |
| | | 38 | | public static Serilog.ILogger Register(string name, Serilog.ILogger logger, bool setAsDefault = false, LoggingLevelS |
| | | 39 | | { |
| | 23 | 40 | | if (_loggers.TryGetValue(name, out var oldLogger) && oldLogger is IDisposable d) |
| | | 41 | | { |
| | 1 | 42 | | d.Dispose(); |
| | | 43 | | } |
| | | 44 | | |
| | 23 | 45 | | _loggers[name] = logger; |
| | 23 | 46 | | if (setAsDefault) |
| | | 47 | | { |
| | 7 | 48 | | Log.Logger = logger; |
| | | 49 | | } |
| | 23 | 50 | | if (levelSwitch != null) |
| | | 51 | | { |
| | 2 | 52 | | _switches[name] = levelSwitch; |
| | | 53 | | } |
| | 23 | 54 | | return logger; |
| | | 55 | | } |
| | | 56 | | |
| | | 57 | | /// <summary> |
| | | 58 | | /// Returns the current Serilog default logger (Log.Logger). |
| | | 59 | | /// </summary> |
| | 1 | 60 | | public static Serilog.ILogger GetDefault() => Log.Logger; |
| | | 61 | | |
| | 46 | 62 | | private static Serilog.ILogger CreateBaselineLogger() => new LoggerConfiguration().CreateLogger(); |
| | | 63 | | |
| | | 64 | | /// <summary> |
| | | 65 | | /// Create a new <see cref="LoggerConfiguration"/> associated with a name. |
| | | 66 | | /// </summary> |
| | | 67 | | /// <param name="name">The name of the logger configuration.</param> |
| | | 68 | | /// <returns>The new logger configuration.</returns> |
| | | 69 | | public static LoggerConfiguration New(string name) |
| | | 70 | | { |
| | 2 | 71 | | var cfg = new LoggerConfiguration() |
| | 2 | 72 | | .Enrich.WithProperty("LoggerName", name); |
| | 2 | 73 | | _configs[name] = cfg; |
| | 2 | 74 | | return cfg; |
| | | 75 | | } |
| | | 76 | | |
| | | 77 | | /// <summary>Set the minimum level for a named logger’s switch.</summary> |
| | | 78 | | /// <param name="name">The name of the logger.</param> |
| | | 79 | | /// <param name="level">The new minimum level to set.</param> |
| | | 80 | | /// <remarks> |
| | | 81 | | /// If the logger or switch does not exist, they will be created. |
| | | 82 | | /// </remarks> |
| | | 83 | | public static void SetLevelSwitch(string name, LogEventLevel level) |
| | | 84 | | { |
| | 6 | 85 | | var sw = EnsureSwitch(name, level); |
| | 6 | 86 | | sw.MinimumLevel = level; |
| | 6 | 87 | | } |
| | | 88 | | |
| | | 89 | | /// <summary>Get the current minimum level for a named logger’s switch.</summary> |
| | | 90 | | /// <param name="name">The name of the logger.</param> |
| | | 91 | | /// <returns>The current minimum level, or null if the logger or switch is not found.</returns> |
| | | 92 | | public static LogEventLevel? GetLevelSwitch(string name) |
| | 3 | 93 | | => _switches.TryGetValue(name, out var sw) ? sw.MinimumLevel : null; |
| | | 94 | | |
| | | 95 | | /// <summary>List all switches and their current levels.</summary> |
| | | 96 | | /// <returns>A dictionary of logger names and their minimum levels.</returns> |
| | | 97 | | public static IReadOnlyDictionary<string, LogEventLevel> ListLevels() |
| | 7 | 98 | | => _switches.ToDictionary(kv => kv.Key, kv => kv.Value.MinimumLevel, StringComparer.OrdinalIgnoreCase); |
| | | 99 | | |
| | | 100 | | /// <summary>CloseAndFlush a logger by name.</summary> |
| | | 101 | | /// <param name="name">The name of the logger to close and flush.</param> |
| | | 102 | | /// <returns> True if the logger was found and closed; otherwise, false.</returns> |
| | | 103 | | public static bool CloseAndFlush(string name) |
| | | 104 | | { |
| | 2 | 105 | | if (!_loggers.TryRemove(name, out var logger)) |
| | | 106 | | { |
| | 1 | 107 | | return false; |
| | | 108 | | } |
| | | 109 | | |
| | | 110 | | bool wasDefault; |
| | | 111 | | // Capture & decide inside lock to avoid race with other threads mutating Log.Logger |
| | | 112 | | lock (_sync) |
| | | 113 | | { |
| | 1 | 114 | | wasDefault = ReferenceEquals(Log.Logger, logger); |
| | 1 | 115 | | } |
| | | 116 | | |
| | 1 | 117 | | if (logger is IDisposable d) |
| | | 118 | | { |
| | | 119 | | // Dispose outside lock (Serilog flush/dispose can perform I/O) |
| | 1 | 120 | | d.Dispose(); |
| | | 121 | | } |
| | 1 | 122 | | _ = _configs.TryRemove(name, out _); |
| | 1 | 123 | | _ = _switches.TryRemove(name, out _); |
| | | 124 | | |
| | 1 | 125 | | if (wasDefault) |
| | 0 | 126 | | { |
| | | 127 | | lock (_sync) |
| | | 128 | | { |
| | | 129 | | // Re-check in case default changed while disposing |
| | 0 | 130 | | if (ReferenceEquals(Log.Logger, logger)) |
| | | 131 | | { |
| | 0 | 132 | | Log.Logger = CreateBaselineLogger(); |
| | | 133 | | } |
| | 0 | 134 | | } |
| | | 135 | | } |
| | 1 | 136 | | return true; |
| | | 137 | | } |
| | | 138 | | |
| | | 139 | | /// <summary> |
| | | 140 | | /// CloseAndFlush a logger instance. |
| | | 141 | | /// </summary> |
| | | 142 | | /// <param name="logger">The logger instance to close and flush.</param> |
| | | 143 | | /// <returns>True if the logger was found and closed; otherwise, false.</returns> |
| | | 144 | | public static bool CloseAndFlush(Serilog.ILogger logger) |
| | 2 | 145 | | { |
| | | 146 | | bool wasDefault; |
| | | 147 | | lock (_sync) |
| | | 148 | | { |
| | 2 | 149 | | wasDefault = ReferenceEquals(Log.Logger, logger); |
| | 2 | 150 | | } |
| | | 151 | | |
| | 2 | 152 | | if (logger is IDisposable d) |
| | | 153 | | { |
| | 2 | 154 | | d.Dispose(); |
| | | 155 | | } |
| | | 156 | | |
| | 2 | 157 | | var removed = false; |
| | 4 | 158 | | var keys = _loggers.Where(kv => ReferenceEquals(kv.Value, logger)).Select(kv => kv.Key).ToList(); |
| | 6 | 159 | | foreach (var key in keys) |
| | | 160 | | { |
| | 1 | 161 | | _ = _loggers.TryRemove(key, out _); |
| | 1 | 162 | | _ = _configs.TryRemove(key, out _); |
| | 1 | 163 | | _ = _switches.TryRemove(key, out _); |
| | 1 | 164 | | removed = true; |
| | | 165 | | } |
| | | 166 | | |
| | 2 | 167 | | if (wasDefault) |
| | 0 | 168 | | { |
| | | 169 | | lock (_sync) |
| | | 170 | | { |
| | 0 | 171 | | if (ReferenceEquals(Log.Logger, logger)) |
| | | 172 | | { |
| | 0 | 173 | | Log.Logger = CreateBaselineLogger(); |
| | | 174 | | } |
| | 0 | 175 | | } |
| | | 176 | | } |
| | 2 | 177 | | return removed; |
| | | 178 | | } |
| | | 179 | | |
| | | 180 | | /// <summary> |
| | | 181 | | /// Get the name of a registered logger instance. |
| | | 182 | | /// </summary> |
| | | 183 | | /// <param name="logger">The logger instance.</param> |
| | | 184 | | /// <returns>The name of the logger, or null if not found.</returns> |
| | | 185 | | public static string? GetName(Serilog.ILogger logger) |
| | | 186 | | { |
| | 10 | 187 | | foreach (var kv in _loggers) |
| | | 188 | | { |
| | 2 | 189 | | if (ReferenceEquals(kv.Value, logger)) |
| | | 190 | | { |
| | 2 | 191 | | return kv.Key; |
| | | 192 | | } |
| | | 193 | | } |
| | | 194 | | |
| | 2 | 195 | | return null; |
| | 2 | 196 | | } |
| | | 197 | | |
| | | 198 | | /// <summary> |
| | | 199 | | /// Try to get the name of a registered logger instance. |
| | | 200 | | /// </summary> |
| | | 201 | | /// <param name="logger">The logger instance.</param> |
| | | 202 | | /// <param name="name">The name of the logger, if found.</param> |
| | | 203 | | /// <returns>True if the name was found; otherwise, false.</returns> |
| | | 204 | | public static bool TryGetName(Serilog.ILogger logger, out string? name) |
| | | 205 | | { |
| | 2 | 206 | | name = GetName(logger); |
| | 2 | 207 | | return name is not null; |
| | | 208 | | } |
| | | 209 | | /// <summary> |
| | | 210 | | /// Check if a logger, configuration, or name exists. |
| | | 211 | | /// </summary> |
| | | 212 | | /// <param name="name">The name of the logger.</param> |
| | | 213 | | /// <returns> True if the logger exists; otherwise, false.</returns> |
| | 2 | 214 | | public static bool Contains(string name) => _loggers.ContainsKey(name); |
| | | 215 | | |
| | | 216 | | /// <summary> |
| | | 217 | | /// Check if a logger, configuration, or name exists. |
| | | 218 | | /// </summary> |
| | | 219 | | /// <param name="logger">The logger instance.</param> |
| | | 220 | | /// <returns> True if the logger exists; otherwise, false.</returns> |
| | 2 | 221 | | public static bool Contains(Serilog.ILogger logger) => _loggers.Values.Contains(logger); |
| | | 222 | | |
| | | 223 | | /// <summary> |
| | | 224 | | /// Check if a logger, configuration, or name exists. |
| | | 225 | | /// </summary> |
| | | 226 | | /// <param name="config">The logger configuration instance.</param> |
| | | 227 | | /// <returns> True if the configuration exists; otherwise, false.</returns> |
| | 1 | 228 | | public static bool Contains(LoggerConfiguration config) => _configs.Values.Contains(config); |
| | | 229 | | |
| | | 230 | | /// <summary>The name of the logger currently set as the Serilog default.</summary> |
| | | 231 | | /// <exception cref="ArgumentException">When the specified logger name is not found.</exception> |
| | | 232 | | public static string DefaultLoggerName |
| | | 233 | | { |
| | 2 | 234 | | get => _loggers.FirstOrDefault(x => x.Value == Log.Logger).Key; |
| | 2 | 235 | | set => Log.Logger = _loggers.TryGetValue(value, out var logger) ? logger : |
| | 2 | 236 | | throw new ArgumentException($"Logger '{value}' not found.", nameof(value)); |
| | | 237 | | } |
| | | 238 | | |
| | | 239 | | /// <summary>Access the Serilog default logger.</summary> |
| | | 240 | | /// <remarks>Setting this property to null resets the default logger to a new empty logger.</remarks> |
| | | 241 | | public static Serilog.ILogger DefaultLogger |
| | | 242 | | { |
| | 1 | 243 | | get => Log.Logger; |
| | 1 | 244 | | set => Log.Logger = value ?? new LoggerConfiguration().CreateLogger(); |
| | | 245 | | } |
| | | 246 | | |
| | | 247 | | /// <summary>Get a logger by name, or null if not found.</summary> |
| | | 248 | | /// <param name="name">The name of the logger.</param> |
| | | 249 | | /// <returns>The logger instance, or null if not found.</returns> |
| | 9 | 250 | | public static Serilog.ILogger? Get(string name) => _loggers.TryGetValue(name, out var logger) ? logger : null; |
| | | 251 | | |
| | | 252 | | /// <summary>List all registered logger names.</summary> |
| | 0 | 253 | | public static string[] List() => [.. _loggers.Keys]; |
| | | 254 | | |
| | | 255 | | /// <summary> |
| | | 256 | | /// List all registered logger instances. |
| | | 257 | | /// </summary> |
| | | 258 | | /// <remarks> |
| | | 259 | | /// The returned array is a snapshot; subsequent registrations or disposals will not affect it. |
| | | 260 | | /// </remarks> |
| | 0 | 261 | | public static Serilog.ILogger[] ListLoggers() => [.. _loggers.Values]; |
| | | 262 | | |
| | | 263 | | /// <summary>Remove and dispose all registered loggers.</summary> |
| | | 264 | | /// <remarks>Also clears the default logger.</remarks> |
| | | 265 | | public static void Clear() |
| | | 266 | | { |
| | | 267 | | // Snapshot keys to minimize time under lock and avoid enumerating while mutated |
| | 46 | 268 | | var snapshot = _loggers.ToArray(); |
| | 130 | 269 | | foreach (var (_, logger) in snapshot) |
| | | 270 | | { |
| | 19 | 271 | | if (logger is IDisposable d) |
| | | 272 | | { |
| | 38 | 273 | | try { d.Dispose(); } catch { /* swallow to ensure all loggers attempt disposal */ } |
| | | 274 | | } |
| | | 275 | | } |
| | 46 | 276 | | _loggers.Clear(); |
| | 46 | 277 | | _configs.Clear(); |
| | 46 | 278 | | _switches.Clear(); |
| | | 279 | | lock (_sync) |
| | | 280 | | { |
| | 46 | 281 | | Log.Logger = CreateBaselineLogger(); |
| | 46 | 282 | | } |
| | 46 | 283 | | } |
| | | 284 | | } |