using Microsoft.Extensions.Logging.Console;
using Chronos.Core.Diagnostics;
using Chronos.Server.Configuration;
using CoreLogLevel = Chronos.Core.Diagnostics.LogLevel;
using MsLogLevel = Microsoft.Extensions.Logging.LogLevel;
namespace Chronos.Server.Hosting;
///
/// The server's logging (BRIEF ยง14.1; owner review 2, R11): the console and the files of /data/logs, each with its
/// own level, which the logging filters read at every line so a change in the admin panel applies at once; the file
/// sink's retention, size limits and rotation; and the engine's , the lower of the two
/// levels, so engine lines reach whichever output wants them. ASP.NET Core's own categories never write below Warning and
/// the host's lifetime never below Information, whatever the levels.
///
public sealed class ServerLogging
{
public const int MaxRetentionDays = 3650;
public const int MaxFileMb = 10 * 1024;
public const int MaxTotalMb = 1024 * 1024;
public const int MaxAuditRetentionDays = ServerOptions.MaxAuditRetentionDays;
public const int MaxDiagnosticsLogMb = 1024;
/// The ranges checks, for the start-up error.
public const string Ranges = "log retention 1 to 3650 days, log file 0 to 10240 MB, logs total 0 to 1048576 MB and not below the log file, "
+ "audit retention 0 to 3650 days, diagnostics logs 1 to 1024 MB";
/// The levels the settings accept, least severe first; their wire names are lower case (information).
public static IReadOnlyList Levels { get; } =
[MsLogLevel.Trace, MsLogLevel.Debug, MsLogLevel.Information, MsLogLevel.Warning, MsLogLevel.Error, MsLogLevel.Critical, MsLogLevel.None];
private volatile MsLogLevel _file;
private volatile MsLogLevel _console;
/// Opens the log files of and applies its levels (call once the data folder is prepared).
public ServerLogging(ServerOptions options)
{
Sink = new FileLogSink(options.LogPath, "server", FileOptions(options));
Apply(options);
}
public FileLogSink Sink { get; }
public MsLogLevel FileLevel => _file;
public MsLogLevel ConsoleLevel => _console;
/// The console and the file provider, each behind a filter that reads its level now.
public void AddTo(ILoggingBuilder logging)
{
logging.ClearProviders();
// Every level reaches the filters; they decide with the levels of the moment.
logging.SetMinimumLevel(MsLogLevel.Trace);
logging.AddSimpleConsole(c => c.SingleLine = true);
logging.AddProvider(new FileLoggerProvider(this));
logging.AddFilter((category, level) => Allows(category, level, ConsoleLevel));
logging.AddFilter((category, level) => Allows(category, level, FileLevel));
}
/// The levels, retention, limits and rotation of , from the next line on.
public void Apply(ServerOptions options)
{
_file = options.LogLevel;
_console = options.ConsoleLogLevel;
Sink.Configure(FileOptions(options));
Log.MinimumLevel = Core(options.LogLevel < options.ConsoleLogLevel ? options.LogLevel : options.ConsoleLogLevel);
}
public static LogFileOptions FileOptions(ServerOptions options) => new()
{
Level = Core(options.LogLevel),
RetentionDays = options.LogRetentionDays,
MaxFileMb = options.LogMaxFileMb,
MaxTotalMb = options.LogMaxTotalMb,
Rotation = options.LogRotation,
};
/// Whether a line of at is written by an output at .
public static bool Allows(string? category, MsLogLevel level, MsLogLevel threshold)
{
if (level == MsLogLevel.None || level < threshold) return false;
if (category is null) return true;
// A line per request below Warning would bury everything else.
if (category.StartsWith("Microsoft.AspNetCore", StringComparison.OrdinalIgnoreCase)) return level >= MsLogLevel.Warning;
if (category.StartsWith("Microsoft.Hosting.Lifetime", StringComparison.OrdinalIgnoreCase)) return level >= MsLogLevel.Information;
return true;
}
/// The engine's level of an ASP.NET Core level (Critical and None become Error, the engine's most severe).
public static CoreLogLevel Core(MsLogLevel level) => level switch
{
MsLogLevel.Trace => CoreLogLevel.Trace,
MsLogLevel.Debug => CoreLogLevel.Debug,
MsLogLevel.Information => CoreLogLevel.Info,
MsLogLevel.Warning => CoreLogLevel.Warning,
_ => CoreLogLevel.Error,
};
public static bool IsLevel(MsLogLevel level) => Levels.Contains(level);
/// information.
public static string Wire(MsLogLevel level) => level.ToString().ToLowerInvariant();
/// daily or hourly.
public static string Wire(LogRotation rotation) => rotation.ToString().ToLowerInvariant();
/// A level by name, any case; info, warn and off are accepted too. Numbers are not levels.
public static bool TryParseLevel(string? text, out MsLogLevel level)
{
level = MsLogLevel.Information;
var name = text?.Trim();
if (string.IsNullOrEmpty(name)) return false;
if (name.Equals("info", StringComparison.OrdinalIgnoreCase)) name = nameof(MsLogLevel.Information);
else if (name.Equals("warn", StringComparison.OrdinalIgnoreCase)) name = nameof(MsLogLevel.Warning);
else if (name.Equals("off", StringComparison.OrdinalIgnoreCase)) name = nameof(MsLogLevel.None);
foreach (var candidate in Levels)
{
if (!candidate.ToString().Equals(name, StringComparison.OrdinalIgnoreCase)) continue;
level = candidate;
return true;
}
return false;
}
public static bool TryParseRotation(string? text, out LogRotation rotation)
{
rotation = LogRotation.Daily;
foreach (var candidate in Enum.GetValues())
{
if (!candidate.ToString().Equals(text?.Trim(), StringComparison.OrdinalIgnoreCase)) continue;
rotation = candidate;
return true;
}
return false;
}
/// Not a level.
public static MsLogLevel ParseLevel(string variable, string value) => TryParseLevel(value, out var level)
? level
: throw new FormatException($"{variable} must be Trace, Debug, Information, Warning, Error, Critical or None.");
/// Neither daily nor hourly.
public static LogRotation ParseRotation(string variable, string value) => TryParseRotation(value, out var rotation)
? rotation
: throw new FormatException($"{variable} must be daily or hourly.");
/// The setting (a property name) whose value is out of range, or null.
public static string? Problem(int retentionDays, int maxFileMb, int maxTotalMb, int auditRetentionDays, int diagnosticsLogMb)
{
if (retentionDays is < 1 or > MaxRetentionDays) return nameof(ServerOptions.LogRetentionDays);
if (maxFileMb is < 0 or > MaxFileMb) return nameof(ServerOptions.LogMaxFileMb);
if (maxTotalMb is < 0 or > MaxTotalMb || LogFileOptions.TotalBelowFile(maxFileMb, maxTotalMb)) return nameof(ServerOptions.LogMaxTotalMb);
if (auditRetentionDays is < 0 or > MaxAuditRetentionDays) return nameof(ServerOptions.AuditRetentionDays);
if (diagnosticsLogMb is < 1 or > MaxDiagnosticsLogMb) return nameof(ServerOptions.DiagnosticsLogMb);
return null;
}
}