| | | 1 | | using ArturRios.Logging.Configuration; |
| | | 2 | | using ArturRios.Logging.Factories; |
| | | 3 | | using ArturRios.Logging.Interfaces; |
| | | 4 | | |
| | | 5 | | namespace ArturRios.Logging.Loggers; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Appends log entries to files on disk, organised by the folder scheme and split level in the configuration. |
| | | 9 | | /// </summary> |
| | | 10 | | /// <remarks> |
| | | 11 | | /// Writes are serialized on a process-wide lock, so entries from concurrent threads never interleave. |
| | | 12 | | /// </remarks> |
| | | 13 | | /// <param name="configuration">Controls the application name, base path, folder scheme and split level.</param> |
| | 56 | 14 | | public class FileLogger(FileLoggerConfiguration configuration) : IInternalLogger |
| | | 15 | | { |
| | | 16 | | private const string DefaultLogFolder = "log"; |
| | | 17 | | private const string FileExtension = ".log"; |
| | 1 | 18 | | private static readonly Lock s_fileLock = new(); |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// The folder name used by <see cref="LogFolderScheme.ByRequest"/>, fixed for the lifetime of this |
| | | 22 | | /// logger. Generating it per write put every single entry in a folder of its own. |
| | | 23 | | /// </summary> |
| | 56 | 24 | | private readonly string _instanceFolderName = Guid.NewGuid().ToString(); |
| | | 25 | | |
| | | 26 | | /// <inheritdoc /> |
| | | 27 | | public void Trace(string message, string filePath, string methodName) |
| | | 28 | | { |
| | 4 | 29 | | Write(CustomLogLevel.Trace, filePath, methodName, message); |
| | 4 | 30 | | } |
| | | 31 | | |
| | | 32 | | /// <inheritdoc /> |
| | | 33 | | public void Debug(string message, string filePath, string methodName) |
| | | 34 | | { |
| | 4 | 35 | | Write(CustomLogLevel.Debug, filePath, methodName, message); |
| | 4 | 36 | | } |
| | | 37 | | |
| | | 38 | | /// <inheritdoc /> |
| | | 39 | | public void Info(string message, string filePath, string methodName) |
| | | 40 | | { |
| | 50 | 41 | | Write(CustomLogLevel.Information, filePath, methodName, message); |
| | 50 | 42 | | } |
| | | 43 | | |
| | | 44 | | /// <inheritdoc /> |
| | | 45 | | public void Warn(string message, string filePath, string methodName) |
| | | 46 | | { |
| | 4 | 47 | | Write(CustomLogLevel.Warning, filePath, methodName, message); |
| | 4 | 48 | | } |
| | | 49 | | |
| | | 50 | | /// <inheritdoc /> |
| | | 51 | | public void Error(string message, string filePath, string methodName) |
| | | 52 | | { |
| | 4 | 53 | | Write(CustomLogLevel.Error, filePath, methodName, message); |
| | 4 | 54 | | } |
| | | 55 | | |
| | | 56 | | /// <inheritdoc /> |
| | | 57 | | public void Exception(string message, string filePath, string methodName) |
| | | 58 | | { |
| | 3 | 59 | | Write(CustomLogLevel.Exception, filePath, methodName, message); |
| | 3 | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <inheritdoc /> |
| | | 63 | | public void Critical(string message, string filePath, string methodName) |
| | | 64 | | { |
| | 3 | 65 | | Write(CustomLogLevel.Critical, filePath, methodName, message); |
| | 3 | 66 | | } |
| | | 67 | | |
| | | 68 | | /// <inheritdoc /> |
| | | 69 | | public void Fatal(string message, string filePath, string methodName) |
| | | 70 | | { |
| | 3 | 71 | | Write(CustomLogLevel.Fatal, filePath, methodName, message); |
| | 3 | 72 | | } |
| | | 73 | | |
| | | 74 | | private void Write(CustomLogLevel level, string filePath, string methodName, string message) |
| | | 75 | | { |
| | | 76 | | // One instant for both the file and the entry: reading the clock twice could put an entry stamped just |
| | | 77 | | // after midnight (or the hour, month, year) into the file of the period before. |
| | 75 | 78 | | var timestamp = DateTime.UtcNow; |
| | 75 | 79 | | var path = BuildFullPath(timestamp); |
| | | 80 | | |
| | 75 | 81 | | CreateDirectoryIfNotExists(path); |
| | | 82 | | |
| | | 83 | | lock (s_fileLock) |
| | | 84 | | { |
| | 75 | 85 | | File.AppendAllText(path, LogEntryFactory.Create(level, filePath, methodName, message, timestamp)); |
| | 75 | 86 | | } |
| | 75 | 87 | | } |
| | | 88 | | |
| | | 89 | | private static void CreateDirectoryIfNotExists(string path) |
| | | 90 | | { |
| | 75 | 91 | | var directory = Path.GetDirectoryName(path); |
| | | 92 | | |
| | 75 | 93 | | if (directory is not null && !Directory.Exists(directory)) |
| | | 94 | | { |
| | 56 | 95 | | Directory.CreateDirectory(directory); |
| | | 96 | | } |
| | 75 | 97 | | } |
| | | 98 | | |
| | | 99 | | private string BuildFullPath(DateTime timestamp) |
| | | 100 | | { |
| | 75 | 101 | | var folderPath = BuildFolderPath(timestamp); |
| | 75 | 102 | | var fileName = BuildFileName(timestamp); |
| | | 103 | | |
| | 75 | 104 | | return Path.Combine(folderPath, $"{fileName}{FileExtension}"); |
| | | 105 | | } |
| | | 106 | | |
| | | 107 | | private string BuildFolderPath(DateTime timestamp) |
| | | 108 | | { |
| | 75 | 109 | | var basePath = configuration.FilePath ?? Path.Combine(AppContext.BaseDirectory, DefaultLogFolder); |
| | 75 | 110 | | var path = basePath; |
| | | 111 | | |
| | 75 | 112 | | switch (configuration.FolderScheme) |
| | | 113 | | { |
| | | 114 | | case LogFolderScheme.AllInOne: |
| | | 115 | | break; |
| | | 116 | | case LogFolderScheme.ByYear: |
| | 2 | 117 | | path = Path.Combine(path, timestamp.Year.ToString()); |
| | 2 | 118 | | break; |
| | | 119 | | case LogFolderScheme.ByMonth: |
| | 3 | 120 | | path = Path.Combine(path, timestamp.Year.ToString(), timestamp.Month.ToString("D2")); |
| | 3 | 121 | | break; |
| | | 122 | | case LogFolderScheme.ByDay: |
| | 2 | 123 | | path = Path.Combine(path, timestamp.Year.ToString(), timestamp.Month.ToString("D2"), timestamp.Day.ToStr |
| | 2 | 124 | | break; |
| | | 125 | | case LogFolderScheme.ByHour: |
| | 3 | 126 | | path = Path.Combine(path, timestamp.Year.ToString(), timestamp.Month.ToString("D2"), timestamp.Day.ToStr |
| | 3 | 127 | | break; |
| | | 128 | | case LogFolderScheme.ByRequest: |
| | 7 | 129 | | path = Path.Combine(path, _instanceFolderName); |
| | 7 | 130 | | break; |
| | | 131 | | default: |
| | 0 | 132 | | throw new ArgumentOutOfRangeException( |
| | 0 | 133 | | nameof(configuration), configuration.FolderScheme, "Unknown log folder scheme."); |
| | | 134 | | } |
| | | 135 | | |
| | 75 | 136 | | return path; |
| | | 137 | | } |
| | | 138 | | |
| | | 139 | | private string BuildFileName(DateTime timestamp) |
| | | 140 | | { |
| | 75 | 141 | | return configuration.FileSplitLevel switch |
| | 75 | 142 | | { |
| | 2 | 143 | | LogSplitLevel.Request => configuration.ApplicationName, |
| | 2 | 144 | | LogSplitLevel.Year => $"{configuration.ApplicationName}_{timestamp:yyyy}", |
| | 2 | 145 | | LogSplitLevel.Month => $"{configuration.ApplicationName}_{timestamp:yyyy_MM}", |
| | 66 | 146 | | LogSplitLevel.Day => $"{configuration.ApplicationName}_{timestamp:yyyy_MM_dd}", |
| | 3 | 147 | | LogSplitLevel.Hour => $"{configuration.ApplicationName}_{timestamp:yyyy_MM_dd_HH}", |
| | 0 | 148 | | _ => throw new ArgumentOutOfRangeException( |
| | 0 | 149 | | nameof(configuration), configuration.FileSplitLevel, "Unknown log split level.") |
| | 75 | 150 | | }; |
| | | 151 | | } |
| | | 152 | | } |