pFad - Phonifier reborn

From 1596f80d66c65ca0cb22358dbaeaa871321a7b99 Mon Sep 17 00:00:00 2001 From: Thiago Garcia Date: Tue, 30 Apr 2019 09:37:12 -0300 Subject: [PATCH 01/29] File retention policy by date - Add configuration to discard files older than X time Fixed constructors for compatibility; Unified where clause to retain files Adjust error messages New test cases --- .../FileLoggerConfigurationExtensions.cs | 36 ++++++++---- .../Sinks/File/RollingFileSink.cs | 25 +++++--- .../RollingFileSinkTests.cs | 57 +++++++++++++++++++ 3 files changed, 99 insertions(+), 19 deletions(-) diff --git a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs index 490803d..c735437 100644 --- a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs +++ b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs @@ -138,6 +138,7 @@ public static LoggerConfiguration File( /// including the current log file. For unlimited retention, pass null. The default is 31. /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Configuration object allowing method chaining. + /// The file will be written using the UTF-8 character set. [Obsolete("New code should not be compiled against this obsolete overload"), EditorBrowsable(EditorBrowsableState.Never)] public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, @@ -165,7 +166,7 @@ public static LoggerConfiguration File( /// Logger sink configuration. /// A formatter, such as , to convert the log events into /// text for the file. If control of regular text formatting is required, use the other - /// overload of + /// overload of /// and specify the outputTemplate parameter instead. /// /// Path to the file. @@ -181,7 +182,7 @@ public static LoggerConfiguration File( /// Allow the log file to be shared by multiple processes. The default is false. /// If provided, a full disk flush will be performed periodically at the specified interval. /// The interval at which logging will roll over to a new file. - /// If true, a new file will be created when the file size limit is reached. Filenames + /// If true, a new file will be created when the file size limit is reached. Filenames /// will have a number appended in the format _NNN, with the first filename given no number. /// The maximum number of log files that will be retained, /// including the current log file. For unlimited retention, pass null. The default is 31. @@ -227,13 +228,18 @@ public static LoggerConfiguration File( /// Allow the log file to be shared by multiple processes. The default is false. /// If provided, a full disk flush will be performed periodically at the specified interval. /// The interval at which logging will roll over to a new file. - /// If true, a new file will be created when the file size limit is reached. Filenames + /// If true, a new file will be created when the file size limit is reached. Filenames /// will have a number appended in the format _NNN, with the first filename given no number. /// The maximum number of log files that will be retained, /// including the current log file. For unlimited retention, pass null. The default is 31. /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Optionally enables hooking into log file lifecycle events. + /// The maximum time after the end of an interval that a rolling log file will be retained. + /// Must be greater than or equal to . + /// Ignored if is . + /// The default is to retain files indefinitely. /// Configuration object allowing method chaining. + /// The file will be written using the UTF-8 character set. public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, string path, @@ -249,7 +255,8 @@ public static LoggerConfiguration File( bool rollOnFileSizeLimit = false, int? retainedFileCountLimit = DefaultRetainedFileCountLimit, Encoding encoding = null, - FileLifecycleHooks hooks = null) + FileLifecycleHooks hooks = null, + TimeSpan? retainedFileTimeLimit = null) { if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration)); if (path == null) throw new ArgumentNullException(nameof(path)); @@ -258,7 +265,7 @@ public static LoggerConfiguration File( var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider); return File(sinkConfiguration, formatter, path, restrictedToMinimumLevel, fileSizeLimitBytes, levelSwitch, buffered, shared, flushToDiskInterval, - rollingInterval, rollOnFileSizeLimit, retainedFileCountLimit, encoding, hooks); + rollingInterval, rollOnFileSizeLimit, retainedFileCountLimit, encoding, hooks, retainedFileTimeLimit); } ///

@@ -267,7 +274,7 @@ public static LoggerConfiguration File( /// Logger sink configuration. /// A formatter, such as , to convert the log events into /// text for the file. If control of regular text formatting is required, use the other - /// overload of + /// overload of /// and specify the outputTemplate parameter instead. /// /// Path to the file. @@ -289,6 +296,10 @@ public static LoggerConfiguration File( /// including the current log file. For unlimited retention, pass null. The default is 31. /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Optionally enables hooking into log file lifecycle events. + /// The maximum time after the end of an interval that a rolling log file will be retained. + /// Must be greater than or equal to . + /// Ignored if is . + /// The default is to retain files indefinitely. /// Configuration object allowing method chaining. public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, @@ -304,7 +315,8 @@ public static LoggerConfiguration File( bool rollOnFileSizeLimit = false, int? retainedFileCountLimit = DefaultRetainedFileCountLimit, Encoding encoding = null, - FileLifecycleHooks hooks = null) + FileLifecycleHooks hooks = null, + TimeSpan? retainedFileTimeLimit = null) { if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration)); if (formatter == null) throw new ArgumentNullException(nameof(formatter)); @@ -312,7 +324,7 @@ public static LoggerConfiguration File( return ConfigureFile(sinkConfiguration.Sink, formatter, path, restrictedToMinimumLevel, fileSizeLimitBytes, levelSwitch, buffered, false, shared, flushToDiskInterval, encoding, rollingInterval, rollOnFileSizeLimit, - retainedFileCountLimit, hooks); + retainedFileCountLimit, hooks, retainedFileTimeLimit); } ///

@@ -432,7 +444,7 @@ public static LoggerConfiguration File( if (path == null) throw new ArgumentNullException(nameof(path)); return ConfigureFile(sinkConfiguration.Sink, formatter, path, restrictedToMinimumLevel, null, levelSwitch, false, true, - false, null, encoding, RollingInterval.Infinite, false, null, hooks); + false, null, encoding, RollingInterval.Infinite, false, null, hooks, null); } static LoggerConfiguration ConfigureFile( @@ -450,13 +462,15 @@ static LoggerConfiguration ConfigureFile( RollingInterval rollingInterval, bool rollOnFileSizeLimit, int? retainedFileCountLimit, - FileLifecycleHooks hooks) + FileLifecycleHooks hooks, + TimeSpan? retainedFileTimeLimit) { if (addSink == null) throw new ArgumentNullException(nameof(addSink)); if (formatter == null) throw new ArgumentNullException(nameof(formatter)); if (path == null) throw new ArgumentNullException(nameof(path)); if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative.", nameof(fileSizeLimitBytes)); if (retainedFileCountLimit.HasValue && retainedFileCountLimit < 1) throw new ArgumentException("At least one file must be retained.", nameof(retainedFileCountLimit)); + if (retainedFileTimeLimit.HasValue && retainedFileTimeLimit < TimeSpan.Zero) throw new ArgumentException("Negative value provided; retained file time limit must be non-negative.", nameof(retainedFileTimeLimit)); if (shared && buffered) throw new ArgumentException("Buffered writes are not available when file sharing is enabled.", nameof(buffered)); if (shared && hooks != null) throw new ArgumentException("File lifecycle hooks are not currently supported for shared log files.", nameof(hooks)); @@ -464,7 +478,7 @@ static LoggerConfiguration ConfigureFile( if (rollOnFileSizeLimit || rollingInterval != RollingInterval.Infinite) { - sink = new RollingFileSink(path, formatter, fileSizeLimitBytes, retainedFileCountLimit, encoding, buffered, shared, rollingInterval, rollOnFileSizeLimit, hooks); + sink = new RollingFileSink(path, formatter, fileSizeLimitBytes, retainedFileCountLimit, encoding, buffered, shared, rollingInterval, rollOnFileSizeLimit, hooks, retainedFileTimeLimit); } else { diff --git a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs index 2db6f24..7d34453 100644 --- a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs @@ -20,6 +20,7 @@ using Serilog.Debugging; using Serilog.Events; using Serilog.Formatting; +using System.Collections.Generic; namespace Serilog.Sinks.File { @@ -29,6 +30,7 @@ sealed class RollingFileSink : ILogEventSink, IFlushableFileSink, IDisposable readonly ITextFormatter _textFormatter; readonly long? _fileSizeLimitBytes; readonly int? _retainedFileCountLimit; + readonly TimeSpan? _retainedFileTimeLimit; readonly Encoding _encoding; readonly bool _buffered; readonly bool _shared; @@ -50,16 +52,19 @@ public RollingFileSink(string path, bool shared, RollingInterval rollingInterval, bool rollOnFileSizeLimit, - FileLifecycleHooks hooks) + FileLifecycleHooks hooks, + TimeSpan? retainedFileTimeLimit) { if (path == null) throw new ArgumentNullException(nameof(path)); - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative."); - if (retainedFileCountLimit.HasValue && retainedFileCountLimit < 1) throw new ArgumentException("Zero or negative value provided; retained file count limit must be at least 1."); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative"); + if (retainedFileCountLimit.HasValue && retainedFileCountLimit < 1) throw new ArgumentException("Zero or negative value provided; retained file count limit must be at least 1"); + if (retainedFileTimeLimit.HasValue && retainedFileTimeLimit < TimeSpan.Zero) throw new ArgumentException("Negative value provided; retained file time limit must be non-negative.", nameof(retainedFileTimeLimit)); _roller = new PathRoller(path, rollingInterval); _textFormatter = textFormatter; _fileSizeLimitBytes = fileSizeLimitBytes; _retainedFileCountLimit = retainedFileCountLimit; + _retainedFileTimeLimit = retainedFileTimeLimit; _encoding = encoding; _buffered = buffered; _shared = shared; @@ -173,7 +178,7 @@ void OpenFile(DateTime now, int? minSequence = null) void ApplyRetentionPolicy(string currentFilePath) { - if (_retainedFileCountLimit == null) return; + if (_retainedFileCountLimit == null && _retainedFileTimeLimit == null) return; var currentFileName = Path.GetFileName(currentFilePath); @@ -181,17 +186,21 @@ void ApplyRetentionPolicy(string currentFilePath) // because files are only opened on response to an event being processed. var potentialMatches = Directory.GetFiles(_roller.LogFileDirectory, _roller.DirectorySearchPattern) .Select(Path.GetFileName) - .Union(new [] { currentFileName }); + .Union(new[] { currentFileName }); var newestFirst = _roller .SelectMatches(potentialMatches) .OrderByDescending(m => m.DateTime) .ThenByDescending(m => m.SequenceNumber) - .Select(m => m.Filename); + .Select(m => new { m.Filename, m.DateTime }); var toRemove = newestFirst - .Where(n => StringComparer.OrdinalIgnoreCase.Compare(currentFileName, n) != 0) - .Skip(_retainedFileCountLimit.Value - 1) + .Where(n => StringComparer.OrdinalIgnoreCase.Compare(currentFileName, n.Filename) != 0) + .SkipWhile((x, i) => (i < (_retainedFileCountLimit - 1 ?? 0)) && + (!_retainedFileTimeLimit.HasValue || + x.DateTime.HasValue && + DateTime.Now.Subtract(_retainedFileTimeLimit.Value).CompareTo(x.DateTime.Value) <= 0)) + .Select(x => x.Filename) .ToList(); foreach (var obsolete in toRemove) diff --git a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs index 2e9f613..746d587 100644 --- a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs +++ b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs @@ -71,6 +71,63 @@ public void WhenRetentionCountIsSetOldFilesAreDeleted() }); } + [Fact] + public void WhenRetentionTimeIsSetOldFilesAreDeleted() + { + LogEvent e1 = Some.InformationEvent(DateTime.Today.AddDays(-5)), + e2 = Some.InformationEvent(e1.Timestamp.AddDays(2)), + e3 = Some.InformationEvent(e2.Timestamp.AddDays(5)); + + TestRollingEventSequence( + (pf, wt) => wt.File(pf, retainedFileTimeLimit: TimeSpan.FromDays(1), rollingInterval: RollingInterval.Day), + new[] {e1, e2, e3}, + files => + { + Assert.Equal(3, files.Count); + Assert.True(!System.IO.File.Exists(files[0])); + Assert.True(!System.IO.File.Exists(files[1])); + Assert.True(System.IO.File.Exists(files[2])); + }); + } + + [Fact] + public void WhenRetentionCountAndTimeIsSetOldFilesAreDeletedByTime() + { + LogEvent e1 = Some.InformationEvent(DateTime.Today.AddDays(-5)), + e2 = Some.InformationEvent(e1.Timestamp.AddDays(2)), + e3 = Some.InformationEvent(e2.Timestamp.AddDays(5)); + + TestRollingEventSequence( + (pf, wt) => wt.File(pf, retainedFileCountLimit: 2, retainedFileTimeLimit: TimeSpan.FromDays(1), rollingInterval: RollingInterval.Day), + new[] {e1, e2, e3}, + files => + { + Assert.Equal(3, files.Count); + Assert.True(!System.IO.File.Exists(files[0])); + Assert.True(!System.IO.File.Exists(files[1])); + Assert.True(System.IO.File.Exists(files[2])); + }); + } + + [Fact] + public void WhenRetentionCountAndTimeIsSetOldFilesAreDeletedByCount() + { + LogEvent e1 = Some.InformationEvent(DateTime.Today.AddDays(-5)), + e2 = Some.InformationEvent(e1.Timestamp.AddDays(2)), + e3 = Some.InformationEvent(e2.Timestamp.AddDays(5)); + + TestRollingEventSequence( + (pf, wt) => wt.File(pf, retainedFileCountLimit: 2, retainedFileTimeLimit: TimeSpan.FromDays(10), rollingInterval: RollingInterval.Day), + new[] {e1, e2, e3}, + files => + { + Assert.Equal(3, files.Count); + Assert.True(!System.IO.File.Exists(files[0])); + Assert.True(System.IO.File.Exists(files[1])); + Assert.True(System.IO.File.Exists(files[2])); + }); + } + [Fact] public void WhenSizeLimitIsBreachedNewFilesCreated() { From b213a7a8481c0f9033d0c129078c829c9cbb4187 Mon Sep 17 00:00:00 2001 From: Thiago Garcia Date: Sat, 1 Jun 2019 18:07:59 -0300 Subject: [PATCH 02/29] Refactoring file filter; fixing docs --- .../FileLoggerConfigurationExtensions.cs | 2 -- .../Sinks/File/RollingFileSink.cs | 19 +++++++++++++------ 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs index c735437..ad6b80b 100644 --- a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs +++ b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs @@ -138,7 +138,6 @@ public static LoggerConfiguration File( /// including the current log file. For unlimited retention, pass null. The default is 31. /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Configuration object allowing method chaining. - /// The file will be written using the UTF-8 character set. [Obsolete("New code should not be compiled against this obsolete overload"), EditorBrowsable(EditorBrowsableState.Never)] public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, @@ -239,7 +238,6 @@ public static LoggerConfiguration File( /// Ignored if is . /// The default is to retain files indefinitely. /// Configuration object allowing method chaining. - /// The file will be written using the UTF-8 character set. public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, string path, diff --git a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs index 7d34453..0e61954 100644 --- a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs @@ -191,15 +191,11 @@ void ApplyRetentionPolicy(string currentFilePath) var newestFirst = _roller .SelectMatches(potentialMatches) .OrderByDescending(m => m.DateTime) - .ThenByDescending(m => m.SequenceNumber) - .Select(m => new { m.Filename, m.DateTime }); + .ThenByDescending(m => m.SequenceNumber); var toRemove = newestFirst .Where(n => StringComparer.OrdinalIgnoreCase.Compare(currentFileName, n.Filename) != 0) - .SkipWhile((x, i) => (i < (_retainedFileCountLimit - 1 ?? 0)) && - (!_retainedFileTimeLimit.HasValue || - x.DateTime.HasValue && - DateTime.Now.Subtract(_retainedFileTimeLimit.Value).CompareTo(x.DateTime.Value) <= 0)) + .SkipWhile(FilterFiles) .Select(x => x.Filename) .ToList(); @@ -217,6 +213,17 @@ void ApplyRetentionPolicy(string currentFilePath) } } + private bool FilterFiles(RollingLogFile file, int index) + { + var isInCountLimit = index < (_retainedFileCountLimit - 1 ?? 0); + + var isInTimeLimit = !_retainedFileTimeLimit.HasValue; + if (_retainedFileTimeLimit.HasValue && file.DateTime.HasValue) + isInTimeLimit = DateTime.Now.Subtract(_retainedFileTimeLimit.Value).CompareTo(file.DateTime.Value) <= 0; + + return isInCountLimit && isInTimeLimit; + } + public void Dispose() { lock (_syncRoot) From 2d3cee74e8f45ddcf4fccedd1876b3c57b70298f Mon Sep 17 00:00:00 2001 From: Maciej Warszawski Date: Fri, 6 Dec 2019 17:30:10 +0100 Subject: [PATCH 03/29] update github sourcelink support package to latest version --- src/Serilog.Sinks.File/Serilog.Sinks.File.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj index f8640f6..d30fc06 100644 --- a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj +++ b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj @@ -30,7 +30,7 @@ - + From 1093c3baa0b60ee94b1c3caf371e47e70c44b04e Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Tue, 4 Feb 2020 15:57:17 +1000 Subject: [PATCH 04/29] Major version bump; accepting breaking changes into dev --- src/Serilog.Sinks.File/Serilog.Sinks.File.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj index d30fc06..41afc3f 100644 --- a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj +++ b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj @@ -2,7 +2,7 @@ Write Serilog events to text files in plain or JSON format. - 4.1.0 + 5.0.0 Serilog Contributors net45;netstandard1.3;netstandard2.0 true From 1b863ff185b8760df6334f7138003d885fbdb21d Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Tue, 4 Feb 2020 16:10:19 +1000 Subject: [PATCH 05/29] Remove explicit private modifier; name tweak; reorganize some conditionals --- .../Sinks/File/RollingFileSink.cs | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs index 0e61954..330dfbc 100644 --- a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs @@ -171,12 +171,12 @@ void OpenFile(DateTime now, int? minSequence = null) throw; } - ApplyRetentionPolicy(path); + ApplyRetentionPolicy(path, now); return; } } - void ApplyRetentionPolicy(string currentFilePath) + void ApplyRetentionPolicy(string currentFilePath, DateTime now) { if (_retainedFileCountLimit == null && _retainedFileTimeLimit == null) return; @@ -195,7 +195,7 @@ void ApplyRetentionPolicy(string currentFilePath) var toRemove = newestFirst .Where(n => StringComparer.OrdinalIgnoreCase.Compare(currentFileName, n.Filename) != 0) - .SkipWhile(FilterFiles) + .SkipWhile((f, i) => ShouldRetainFile(f, i, now)) .Select(x => x.Filename) .ToList(); @@ -213,15 +213,18 @@ void ApplyRetentionPolicy(string currentFilePath) } } - private bool FilterFiles(RollingLogFile file, int index) + bool ShouldRetainFile(RollingLogFile file, int index, DateTime now) { - var isInCountLimit = index < (_retainedFileCountLimit - 1 ?? 0); + if (_retainedFileCountLimit.HasValue && index >= _retainedFileCountLimit.Value) + return false; - var isInTimeLimit = !_retainedFileTimeLimit.HasValue; - if (_retainedFileTimeLimit.HasValue && file.DateTime.HasValue) - isInTimeLimit = DateTime.Now.Subtract(_retainedFileTimeLimit.Value).CompareTo(file.DateTime.Value) <= 0; - - return isInCountLimit && isInTimeLimit; + if (_retainedFileTimeLimit.HasValue && file.DateTime.HasValue && + file.DateTime.Value < now.Subtract(_retainedFileTimeLimit.Value)) + { + return false; + } + + return true; } public void Dispose() From c2375ebd46f872042b5b68fe763b391f314369e2 Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Tue, 4 Feb 2020 16:33:21 +1000 Subject: [PATCH 06/29] Fix test; update to use the 2019 build image --- appveyor.yml | 7 +++---- serilog-sinks-file.sln.DotSettings | 2 ++ src/Serilog.Sinks.File/Serilog.Sinks.File.csproj | 5 ----- src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs | 3 +-- test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs | 8 ++++---- 5 files changed, 10 insertions(+), 15 deletions(-) create mode 100644 serilog-sinks-file.sln.DotSettings diff --git a/appveyor.yml b/appveyor.yml index 79ee987..ef5f126 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,16 +1,15 @@ version: '{build}' skip_tags: true image: - - Visual Studio 2017 - - Ubuntu -configuration: Release + - Visual Studio 2019 + - Ubuntu1804 build_script: - ps: ./Build.ps1 for: - matrix: only: - - image: Ubuntu + - image: Ubuntu1804 build_script: - sh build.sh test: off diff --git a/serilog-sinks-file.sln.DotSettings b/serilog-sinks-file.sln.DotSettings new file mode 100644 index 0000000..bfd92fd --- /dev/null +++ b/serilog-sinks-file.sln.DotSettings @@ -0,0 +1,2 @@ + + True \ No newline at end of file diff --git a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj index 41afc3f..14bdff7 100644 --- a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj +++ b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj @@ -6,11 +6,9 @@ Serilog Contributors net45;netstandard1.3;netstandard2.0 true - Serilog.Sinks.File ../../assets/Serilog.snk true true - Serilog.Sinks.File serilog;file http://serilog.net/images/serilog-sink-nuget.png http://serilog.net @@ -20,10 +18,7 @@ false Serilog true - Serilog.Sinks.File - true - false true $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb diff --git a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs index e6d29d5..d007cd5 100644 --- a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs @@ -20,7 +20,6 @@ using Serilog.Debugging; using Serilog.Events; using Serilog.Formatting; -using System.Collections.Generic; namespace Serilog.Sinks.File { @@ -216,7 +215,7 @@ void ApplyRetentionPolicy(string currentFilePath, DateTime now) bool ShouldRetainFile(RollingLogFile file, int index, DateTime now) { - if (_retainedFileCountLimit.HasValue && index >= _retainedFileCountLimit.Value) + if (_retainedFileCountLimit.HasValue && index >= _retainedFileCountLimit.Value - 1) return false; if (_retainedFileTimeLimit.HasValue && file.DateTime.HasValue && diff --git a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs index 5d0879f..568f7a7 100644 --- a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs +++ b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs @@ -8,6 +8,7 @@ using Serilog.Events; using Serilog.Sinks.File.Tests.Support; using Serilog.Configuration; +using Serilog.Core; namespace Serilog.Sinks.File.Tests { @@ -142,7 +143,7 @@ public void WhenRetentionCountAndArchivingHookIsSetOldFilesAreCopiedAndOriginalD files => { Assert.Equal(3, files.Count); - Assert.True(!System.IO.File.Exists(files[0])); + Assert.False(System.IO.File.Exists(files[0])); Assert.True(System.IO.File.Exists(files[1])); Assert.True(System.IO.File.Exists(files[2])); Assert.True(System.IO.File.Exists(ArchiveOldLogsHook.AddTopDirectory(files[0], archiveDirectory))); @@ -241,7 +242,7 @@ public void IfTheLogFolderDoesNotExistItWillBeCreated() var folder = Path.Combine(temp, Guid.NewGuid().ToString()); var pathFormat = Path.Combine(folder, fileName); - ILogger log = null; + Logger log = null; try { @@ -255,8 +256,7 @@ public void IfTheLogFolderDoesNotExistItWillBeCreated() } finally { - var disposable = (IDisposable)log; - if (disposable != null) disposable.Dispose(); + log?.Dispose(); Directory.Delete(temp, true); } } From 73ac5ff60cc5cf24442fee04e0cb1fd3d46a71e0 Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Wed, 5 Feb 2020 09:03:32 +1000 Subject: [PATCH 07/29] .NET Core App 3.0 target; misc clean-up --- example/Sample/Sample.csproj | 3 -- serilog-sinks-file.sln.DotSettings | 1 + .../Serilog.Sinks.File.csproj | 34 ++++++++----------- .../Serilog.Sinks.File.Tests/FileSinkTests.cs | 4 +-- .../RollingFileSinkTests.cs | 4 +-- .../Serilog.Sinks.File.Tests.csproj | 9 +++-- test/Serilog.Sinks.File.Tests/Support/Some.cs | 9 +++-- .../TemplatedPathRollerTests.cs | 20 +++++------ 8 files changed, 35 insertions(+), 49 deletions(-) diff --git a/example/Sample/Sample.csproj b/example/Sample/Sample.csproj index ec04f95..e307db1 100644 --- a/example/Sample/Sample.csproj +++ b/example/Sample/Sample.csproj @@ -17,8 +17,5 @@ - - - diff --git a/serilog-sinks-file.sln.DotSettings b/serilog-sinks-file.sln.DotSettings index bfd92fd..95887cc 100644 --- a/serilog-sinks-file.sln.DotSettings +++ b/serilog-sinks-file.sln.DotSettings @@ -1,2 +1,3 @@ + True True \ No newline at end of file diff --git a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj index 14bdff7..f498bf6 100644 --- a/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj +++ b/src/Serilog.Sinks.File/Serilog.Sinks.File.csproj @@ -4,7 +4,7 @@ Write Serilog events to text files in plain or JSON format. 5.0.0 Serilog Contributors - net45;netstandard1.3;netstandard2.0 + net45;netstandard1.3;netstandard2.0;netcoreapp3.0 true ../../assets/Serilog.snk true @@ -18,7 +18,7 @@ false Serilog true - true + true false true $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb @@ -26,13 +26,7 @@ - - - - - - - + @@ -43,23 +37,23 @@ $(DefineConstants);OS_MUTEX - + $(DefineConstants);OS_MUTEX - - - - - - - + + + + + + + - - - + + + diff --git a/test/Serilog.Sinks.File.Tests/FileSinkTests.cs b/test/Serilog.Sinks.File.Tests/FileSinkTests.cs index 2d0f210..10fe926 100644 --- a/test/Serilog.Sinks.File.Tests/FileSinkTests.cs +++ b/test/Serilog.Sinks.File.Tests/FileSinkTests.cs @@ -130,7 +130,7 @@ public void WhenLimitIsSpecifiedAndEncodingHasNoPreambleDataIsCorrectlyAppendedT long? maxBytes = 5000; var encoding = new UTF8Encoding(false); - Assert.Equal(0, encoding.GetPreamble().Length); + Assert.Empty(encoding.GetPreamble()); WriteTwoEventsAndCheckOutputFileLength(maxBytes, encoding); } @@ -139,7 +139,7 @@ public void WhenLimitIsNotSpecifiedAndEncodingHasNoPreambleDataIsCorrectlyAppend { var encoding = new UTF8Encoding(false); - Assert.Equal(0, encoding.GetPreamble().Length); + Assert.Empty(encoding.GetPreamble()); WriteTwoEventsAndCheckOutputFileLength(null, encoding); } diff --git a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs index 568f7a7..d295dfc 100644 --- a/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs +++ b/test/Serilog.Sinks.File.Tests/RollingFileSinkTests.cs @@ -227,8 +227,8 @@ public void WhenStreamWrapperSpecifiedIsUsedForRolledFiles() textStream.Position = 0; var lines = textStream.ReadAllLines(); - Assert.Equal(1, lines.Count); - Assert.True(lines[0].EndsWith(logEvents[i].MessageTemplate.Text)); + Assert.Single(lines); + Assert.EndsWith(logEvents[i].MessageTemplate.Text, lines[0]); } } } diff --git a/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj b/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj index 3491e32..7703dc7 100644 --- a/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj +++ b/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj @@ -1,13 +1,12 @@ - net452;netcoreapp1.0;netcoreapp2.0 + net452;netcoreapp1.0;netcoreapp2.0;netcoreapp3.1 true Serilog.Sinks.File.Tests ../../assets/Serilog.snk true true - Serilog.Sinks.RollingFile.Tests true $(PackageTargetFallback);dnxcore50;portable-net45+win8 1.0.4 @@ -18,9 +17,9 @@ - - - + + + diff --git a/test/Serilog.Sinks.File.Tests/Support/Some.cs b/test/Serilog.Sinks.File.Tests/Support/Some.cs index 2d29d4d..f0c7fd9 100644 --- a/test/Serilog.Sinks.File.Tests/Support/Some.cs +++ b/test/Serilog.Sinks.File.Tests/Support/Some.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; @@ -7,6 +6,8 @@ using Serilog.Parsing; using Xunit.Sdk; +// ReSharper disable UnusedMember.Global + namespace Serilog.Sinks.File.Tests.Support { static class Some @@ -46,10 +47,8 @@ public static DateTimeOffset OffsetInstant() public static LogEvent LogEvent(string messageTemplate, params object[] propertyValues) { var log = new LoggerConfiguration().CreateLogger(); - MessageTemplate template; - IEnumerable properties; #pragma warning disable Serilog004 // Constant MessageTemplate verifier - if (!log.BindMessageTemplate(messageTemplate, propertyValues, out template, out properties)) + if (!log.BindMessageTemplate(messageTemplate, propertyValues, out var template, out var properties)) #pragma warning restore Serilog004 // Constant MessageTemplate verifier { throw new XunitException("Template could not be bound."); @@ -65,7 +64,7 @@ public static LogEvent LogEvent(DateTimeOffset? timestamp = null, LogEventLevel public static LogEvent InformationEvent(DateTimeOffset? timestamp = null) { - return LogEvent(timestamp, LogEventLevel.Information); + return LogEvent(timestamp); } public static LogEvent DebugEvent(DateTimeOffset? timestamp = null) diff --git a/test/Serilog.Sinks.File.Tests/TemplatedPathRollerTests.cs b/test/Serilog.Sinks.File.Tests/TemplatedPathRollerTests.cs index 5e1b015..65a974c 100644 --- a/test/Serilog.Sinks.File.Tests/TemplatedPathRollerTests.cs +++ b/test/Serilog.Sinks.File.Tests/TemplatedPathRollerTests.cs @@ -12,8 +12,7 @@ public void TheLogFileIncludesDateToken() { var roller = new PathRoller(Path.Combine("Logs", "log-.txt"), RollingInterval.Day); var now = new DateTime(2013, 7, 14, 3, 24, 9, 980); - string path; - roller.GetLogFilePath(now, null, out path); + roller.GetLogFilePath(now, null, out var path); AssertEqualAbsolute(Path.Combine("Logs", "log-20130714.txt"), path); } @@ -22,8 +21,7 @@ public void ANonZeroIncrementIsIncludedAndPadded() { var roller = new PathRoller(Path.Combine("Logs", "log-.txt"), RollingInterval.Day); var now = new DateTime(2013, 7, 14, 3, 24, 9, 980); - string path; - roller.GetLogFilePath(now, 12, out path); + roller.GetLogFilePath(now, 12, out var path); AssertEqualAbsolute(Path.Combine("Logs", "log-20130714_012.txt"), path); } @@ -46,8 +44,7 @@ public void TheLogFileIsNotRequiredToIncludeAnExtension() { var roller = new PathRoller(Path.Combine("Logs", "log-"), RollingInterval.Day); var now = new DateTime(2013, 7, 14, 3, 24, 9, 980); - string path; - roller.GetLogFilePath(now, null, out path); + roller.GetLogFilePath(now, null, out var path); AssertEqualAbsolute(Path.Combine("Logs", "log-20130714"), path); } @@ -56,19 +53,18 @@ public void TheLogFileIsNotRequiredToIncludeADirectory() { var roller = new PathRoller("log-", RollingInterval.Day); var now = new DateTime(2013, 7, 14, 3, 24, 9, 980); - string path; - roller.GetLogFilePath(now, null, out path); + roller.GetLogFilePath(now, null, out var path); AssertEqualAbsolute("log-20130714", path); } [Fact] - public void MatchingExcludesSimilarButNonmatchingFiles() + public void MatchingExcludesSimilarButNonMatchingFiles() { var roller = new PathRoller("log-.txt", RollingInterval.Day); const string similar1 = "log-0.txt"; - const string similar2 = "log-helloyou.txt"; + const string similar2 = "log-hello.txt"; var matched = roller.SelectMatches(new[] { similar1, similar2 }); - Assert.Equal(0, matched.Count()); + Assert.Empty(matched); } [Fact] @@ -86,7 +82,7 @@ public void MatchingSelectsFiles(string template, string zeroth, string thirtyFi var roller = new PathRoller(template, interval); var matched = roller.SelectMatches(new[] { zeroth, thirtyFirst }).ToArray(); Assert.Equal(2, matched.Length); - Assert.Equal(null, matched[0].SequenceNumber); + Assert.Null(matched[0].SequenceNumber); Assert.Equal(31, matched[1].SequenceNumber); } From 849ad79f453e036937e1d5cacd10901afe9a77c8 Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Tue, 14 Apr 2020 08:36:19 +1000 Subject: [PATCH 08/29] Cut back frameworks targeted by tests to keep build manageable --- .../Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj b/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj index 7703dc7..fcf2880 100644 --- a/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj +++ b/test/Serilog.Sinks.File.Tests/Serilog.Sinks.File.Tests.csproj @@ -1,7 +1,7 @@ - net452;netcoreapp1.0;netcoreapp2.0;netcoreapp3.1 + net47;netcoreapp3.1 true Serilog.Sinks.File.Tests ../../assets/Serilog.snk @@ -17,7 +17,7 @@ - + @@ -31,5 +31,4 @@ - From 6df7cae82db3a10ba52441196417a8ff28dccbb3 Mon Sep 17 00:00:00 2001 From: Eamon Hetherton Date: Fri, 17 Apr 2020 13:19:09 +1000 Subject: [PATCH 09/29] Added way to chain FileLifeCycleHooks together --- .../File/FileLifecycleHooksExtensions.cs | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs diff --git a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs new file mode 100644 index 0000000..acc5513 --- /dev/null +++ b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs @@ -0,0 +1,71 @@ +// Copyright 2019 Serilog Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System; +using System.IO; +using System.Text; + +namespace Serilog.Sinks.File +{ + ///

+ /// FileLifecycleHooks extension methods + ///

+ public static class FileLifecycleHooksExtensions + { + ///

+ /// Creates a chain of that have their methods called sequentially + /// Can be used to compose together; e.g. add header information to each log file and + /// compress it. + ///

+ /// + ///


+        /// var hooks = new GZipHooks().ChainTo(new HeaderWriter("File Header"));
+        ///

+ /// + /// The first to have its methods called in the chain + /// The second to have its methods called in the chain + /// + public static FileLifecycleHooks ChainTo(this FileLifecycleHooks first, FileLifecycleHooks second) + { + return new FileLifeCycleHookChain(first, second); + } + + class FileLifeCycleHookChain : FileLifecycleHooks + { + private readonly FileLifecycleHooks[] hooks; + + public FileLifeCycleHookChain(params FileLifecycleHooks[] hooks) + { + this.hooks = hooks ?? throw new ArgumentNullException(nameof(hooks)); + } + + public override Stream OnFileOpened(Stream underlyingStream, Encoding encoding) + { + for (int i = 0; i < hooks.Length; i++) + { + underlyingStream = hooks[i].OnFileOpened(underlyingStream, encoding); + } + return underlyingStream; + } + + public override void OnFileDeleting(string path) + { + for (int i = 0; i < hooks.Length; i++) + { + hooks[i].OnFileDeleting(path); + } + } + } + } +} From 1af50969e0dafe596b41d4f8c514ca32acbbce02 Mon Sep 17 00:00:00 2001 From: Eamon Hetherton Date: Fri, 17 Apr 2020 13:21:09 +1000 Subject: [PATCH 10/29] stop using params when current implementation only ever has two values --- .../File/FileLifecycleHooksExtensions.cs | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs index acc5513..f79c768 100644 --- a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs +++ b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs @@ -43,28 +43,27 @@ public static FileLifecycleHooks ChainTo(this FileLifecycleHooks first, FileLife class FileLifeCycleHookChain : FileLifecycleHooks { - private readonly FileLifecycleHooks[] hooks; + private readonly FileLifecycleHooks _first; + private readonly FileLifecycleHooks _second; - public FileLifeCycleHookChain(params FileLifecycleHooks[] hooks) + public FileLifeCycleHookChain(FileLifecycleHooks first, FileLifecycleHooks second) { - this.hooks = hooks ?? throw new ArgumentNullException(nameof(hooks)); + _first = first ?? throw new ArgumentNullException(nameof(first)); + _second = second ?? throw new ArgumentNullException(nameof(second)); } public override Stream OnFileOpened(Stream underlyingStream, Encoding encoding) { - for (int i = 0; i < hooks.Length; i++) - { - underlyingStream = hooks[i].OnFileOpened(underlyingStream, encoding); - } - return underlyingStream; + var firstStreamResult = _first.OnFileOpened(underlyingStream, encoding); + var secondStreamResult = _second.OnFileOpened(firstStreamResult, encoding); + + return secondStreamResult; } public override void OnFileDeleting(string path) { - for (int i = 0; i < hooks.Length; i++) - { - hooks[i].OnFileDeleting(path); - } + _first.OnFileDeleting(path); + _second.OnFileDeleting(path); } } } From cad86bd4ae68ecdb6a476f6a53e8ca1d3bd1cc95 Mon Sep 17 00:00:00 2001 From: Eamon Hetherton Date: Fri, 17 Apr 2020 16:21:49 +1000 Subject: [PATCH 11/29] refactor "ChainTo" to instance method "Then" --- .../Sinks/File/FileLifeCycleHookChain.cs | 46 ++++++++++++ .../Sinks/File/FileLifecycleHooks.cs | 17 +++++ .../File/FileLifecycleHooksExtensions.cs | 70 ------------------- 3 files changed, 63 insertions(+), 70 deletions(-) create mode 100644 src/Serilog.Sinks.File/Sinks/File/FileLifeCycleHookChain.cs delete mode 100644 src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs diff --git a/src/Serilog.Sinks.File/Sinks/File/FileLifeCycleHookChain.cs b/src/Serilog.Sinks.File/Sinks/File/FileLifeCycleHookChain.cs new file mode 100644 index 0000000..cea5095 --- /dev/null +++ b/src/Serilog.Sinks.File/Sinks/File/FileLifeCycleHookChain.cs @@ -0,0 +1,46 @@ +// Copyright 2019 Serilog Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System; +using System.IO; +using System.Text; + +namespace Serilog.Sinks.File +{ + class FileLifeCycleHookChain : FileLifecycleHooks + { + private readonly FileLifecycleHooks _first; + private readonly FileLifecycleHooks _second; + + public FileLifeCycleHookChain(FileLifecycleHooks first, FileLifecycleHooks second) + { + _first = first ?? throw new ArgumentNullException(nameof(first)); + _second = second ?? throw new ArgumentNullException(nameof(second)); + } + + public override Stream OnFileOpened(Stream underlyingStream, Encoding encoding) + { + var firstStreamResult = _first.OnFileOpened(underlyingStream, encoding); + var secondStreamResult = _second.OnFileOpened(firstStreamResult, encoding); + + return secondStreamResult; + } + + public override void OnFileDeleting(string path) + { + _first.OnFileDeleting(path); + _second.OnFileDeleting(path); + } + } +} diff --git a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs index fbaf133..e804cad 100644 --- a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs +++ b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs @@ -43,5 +43,22 @@ public abstract class FileLifecycleHooks ///

/// The full path to the file being deleted. public virtual void OnFileDeleting(string path) {} + + ///

+ /// Creates a chain of that have their methods called sequentially + /// Can be used to compose together; e.g. add header information to each log file and + /// compress it. + ///

+ /// + ///


+        /// var hooks = new GZipHooks().Then(new HeaderWriter("File Header"));
+        ///

+ /// + /// The next to have its methods called in the chain + /// + public FileLifecycleHooks Then(FileLifecycleHooks next) + { + return new FileLifeCycleHookChain(this, next); + } } } diff --git a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs b/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs deleted file mode 100644 index f79c768..0000000 --- a/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooksExtensions.cs +++ /dev/null @@ -1,70 +0,0 @@ -// Copyright 2019 Serilog Contributors -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -using System; -using System.IO; -using System.Text; - -namespace Serilog.Sinks.File -{ - ///

- /// FileLifecycleHooks extension methods - ///

- public static class FileLifecycleHooksExtensions - { - ///

- /// Creates a chain of that have their methods called sequentially - /// Can be used to compose together; e.g. add header information to each log file and - /// compress it. - ///

- /// - ///


-        /// var hooks = new GZipHooks().ChainTo(new HeaderWriter("File Header"));
-        ///

- /// - /// The first to have its methods called in the chain - /// The second to have its methods called in the chain - /// - public static FileLifecycleHooks ChainTo(this FileLifecycleHooks first, FileLifecycleHooks second) - { - return new FileLifeCycleHookChain(first, second); - } - - class FileLifeCycleHookChain : FileLifecycleHooks - { - private readonly FileLifecycleHooks _first; - private readonly FileLifecycleHooks _second; - - public FileLifeCycleHookChain(FileLifecycleHooks first, FileLifecycleHooks second) - { - _first = first ?? throw new ArgumentNullException(nameof(first)); - _second = second ?? throw new ArgumentNullException(nameof(second)); - } - - public override Stream OnFileOpened(Stream underlyingStream, Encoding encoding) - { - var firstStreamResult = _first.OnFileOpened(underlyingStream, encoding); - var secondStreamResult = _second.OnFileOpened(firstStreamResult, encoding); - - return secondStreamResult; - } - - public override void OnFileDeleting(string path) - { - _first.OnFileDeleting(path); - _second.OnFileDeleting(path); - } - } - } -} From 5358051a603170cb21df89d80efefc8066289117 Mon Sep 17 00:00:00 2001 From: cocowalla <800977+cocowalla@users.noreply.github.com> Date: Wed, 29 Apr 2020 14:51:11 +0100 Subject: [PATCH 12/29] docs: file lifecycle hooks --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5a78565..4bac086 100644 --- a/README.md +++ b/README.md @@ -193,4 +193,19 @@ By default, the file sink will flush each event written through it to disk. To i The [Serilog.Sinks.Async](https://github.com/serilog/serilog-sinks-async) package can be used to wrap the file sink and perform all disk access on a background worker thread. +### Extensibility +[`FileLifecycleHooks`](https://github.com/serilog/serilog-sinks-file/blob/master/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs) provide an extensibility point that allows hooking into different parts of the life cycle of a log file. + +You can create a hook by extending from [`FileLifecycleHooks`](https://github.com/serilog/serilog-sinks-file/blob/master/src/Serilog.Sinks.File/Sinks/File/FileLifecycleHooks.cs) and overriding the `OnFileOpened` and/or `OnFileDeleting` methods. + +- `OnFileOpened` provides access to the underlying stream that log events are written to, before Serilog begins writing events. You can use this to write your own data to the stream (for example, to write a header row), or to wrap the stream in another stream (for example, to add buffering, compression or encryption) + +- `OnFileDeleting` provides a means to work with obsolete rolling log files, *before* they are deleted by Serilog's retention mechanism - for example, to archive log files to another location + +Available hooks: + +- [serilog-sinks-file-header](https://github.com/cocowalla/serilog-sinks-file-header): writes a header to the start of each log file +- [serilog-sinks-file-gzip](https://github.com/cocowalla/serilog-sinks-file-gzip): compresses logs as they are written, using streaming GZIP compression +- [serilog-sinks-file-archive](https://github.com/cocowalla/serilog-sinks-file-archive): archives obsolete rolling log files before they are deleted by Serilog's retention mechanism + _Copyright © 2016 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._ From 2be5531de626c35a56920a594c3dd804f8aba5f6 Mon Sep 17 00:00:00 2001 From: cocowalla <800977+cocowalla@users.noreply.github.com> Date: Fri, 15 May 2020 20:45:27 +0100 Subject: [PATCH 13/29] fix: #146, file size limit --- .../FileLoggerConfigurationExtensions.cs | 10 +++++----- src/Serilog.Sinks.File/Sinks/File/FileSink.cs | 2 +- src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs | 4 ++-- .../Sinks/File/SharedFileSink.AtomicAppend.cs | 4 ++-- .../Sinks/File/SharedFileSink.OSMutex.cs | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs index ad6b80b..74383b2 100644 --- a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs +++ b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs @@ -32,7 +32,7 @@ namespace Serilog public static class FileLoggerConfigurationExtensions { const int DefaultRetainedFileCountLimit = 31; // A long month of logs - const long DefaultFileSizeLimitBytes = 1L * 1024 * 1024 * 1024; + const long DefaultFileSizeLimitBytes = 1L * 1024 * 1024 * 1024; // 1GB const string DefaultOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}"; ///

@@ -181,7 +181,7 @@ public static LoggerConfiguration File( /// Allow the log file to be shared by multiple processes. The default is false. /// If provided, a full disk flush will be performed periodically at the specified interval. /// The interval at which logging will roll over to a new file. - /// If true, a new file will be created when the file size limit is reached. Filenames + /// If true, a new file will be created when the file size limit is reached. Filenames /// will have a number appended in the format _NNN, with the first filename given no number. /// The maximum number of log files that will be retained, /// including the current log file. For unlimited retention, pass null. The default is 31. @@ -227,7 +227,7 @@ public static LoggerConfiguration File( /// Allow the log file to be shared by multiple processes. The default is false. /// If provided, a full disk flush will be performed periodically at the specified interval. /// The interval at which logging will roll over to a new file. - /// If true, a new file will be created when the file size limit is reached. Filenames + /// If true, a new file will be created when the file size limit is reached. Filenames /// will have a number appended in the format _NNN, with the first filename given no number. /// The maximum number of log files that will be retained, /// including the current log file. For unlimited retention, pass null. The default is 31. @@ -377,7 +377,7 @@ public static LoggerConfiguration File( { return File(sinkConfiguration, formatter, path, restrictedToMinimumLevel, levelSwitch, null, null); } - + ///

/// Write audit log events to the specified file. ///

@@ -466,7 +466,7 @@ static LoggerConfiguration ConfigureFile( if (addSink == null) throw new ArgumentNullException(nameof(addSink)); if (formatter == null) throw new ArgumentNullException(nameof(formatter)); if (path == null) throw new ArgumentNullException(nameof(path)); - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative.", nameof(fileSizeLimitBytes)); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 1) throw new ArgumentException("Invalid value provided; file size limit must be at least 1 byte, or null.", nameof(fileSizeLimitBytes)); if (retainedFileCountLimit.HasValue && retainedFileCountLimit < 1) throw new ArgumentException("At least one file must be retained.", nameof(retainedFileCountLimit)); if (retainedFileTimeLimit.HasValue && retainedFileTimeLimit < TimeSpan.Zero) throw new ArgumentException("Negative value provided; retained file time limit must be non-negative.", nameof(retainedFileTimeLimit)); if (shared && buffered) throw new ArgumentException("Buffered writes are not available when file sharing is enabled.", nameof(buffered)); diff --git a/src/Serilog.Sinks.File/Sinks/File/FileSink.cs b/src/Serilog.Sinks.File/Sinks/File/FileSink.cs index 8a913fa..451ba55 100644 --- a/src/Serilog.Sinks.File/Sinks/File/FileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/FileSink.cs @@ -61,7 +61,7 @@ internal FileSink( FileLifecycleHooks hooks) { if (path == null) throw new ArgumentNullException(nameof(path)); - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative."); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 1) throw new ArgumentException("Invalid value provided; file size limit must be at least 1 byte, or null."); _textFormatter = textFormatter ?? throw new ArgumentNullException(nameof(textFormatter)); _fileSizeLimitBytes = fileSizeLimitBytes; _buffered = buffered; diff --git a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs index d007cd5..0eb4463 100644 --- a/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/RollingFileSink.cs @@ -55,7 +55,7 @@ public RollingFileSink(string path, TimeSpan? retainedFileTimeLimit) { if (path == null) throw new ArgumentNullException(nameof(path)); - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) throw new ArgumentException("Negative value provided; file size limit must be non-negative"); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 1) throw new ArgumentException("Invalid value provided; file size limit must be at least 1 byte, or null."); if (retainedFileCountLimit.HasValue && retainedFileCountLimit < 1) throw new ArgumentException("Zero or negative value provided; retained file count limit must be at least 1"); if (retainedFileTimeLimit.HasValue && retainedFileTimeLimit < TimeSpan.Zero) throw new ArgumentException("Negative value provided; retained file time limit must be non-negative.", nameof(retainedFileTimeLimit)); @@ -223,7 +223,7 @@ bool ShouldRetainFile(RollingLogFile file, int index, DateTime now) { return false; } - + return true; } diff --git a/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.AtomicAppend.cs b/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.AtomicAppend.cs index 866f807..25e8867 100644 --- a/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.AtomicAppend.cs +++ b/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.AtomicAppend.cs @@ -53,8 +53,8 @@ public sealed class SharedFileSink : IFileSink, IDisposable /// public SharedFileSink(string path, ITextFormatter textFormatter, long? fileSizeLimitBytes, Encoding encoding = null) { - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) - throw new ArgumentException("Negative value provided; file size limit must be non-negative"); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 1) + throw new ArgumentException("Invalid value provided; file size limit must be at least 1 byte, or null"); _path = path ?? throw new ArgumentNullException(nameof(path)); _textFormatter = textFormatter ?? throw new ArgumentNullException(nameof(textFormatter)); diff --git a/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.OSMutex.cs b/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.OSMutex.cs index 41a19ef..38b2326 100644 --- a/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.OSMutex.cs +++ b/src/Serilog.Sinks.File/Sinks/File/SharedFileSink.OSMutex.cs @@ -53,8 +53,8 @@ public sealed class SharedFileSink : IFileSink, IDisposable public SharedFileSink(string path, ITextFormatter textFormatter, long? fileSizeLimitBytes, Encoding encoding = null) { if (path == null) throw new ArgumentNullException(nameof(path)); - if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 0) - throw new ArgumentException("Negative value provided; file size limit must be non-negative"); + if (fileSizeLimitBytes.HasValue && fileSizeLimitBytes < 1) + throw new ArgumentException("Invalid value provided; file size limit must be at least 1 byte, or null."); _textFormatter = textFormatter ?? throw new ArgumentNullException(nameof(textFormatter)); _fileSizeLimitBytes = fileSizeLimitBytes; From 455c32c96d4b08aa70a6a4bdce856327726ef1aa Mon Sep 17 00:00:00 2001 From: Nicholas Blumhardt Date: Sat, 16 May 2020 07:31:17 +1000 Subject: [PATCH 14/29] Update NuGet.org publishing key --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index ef5f126..7e41204 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -18,7 +18,7 @@ artifacts: deploy: - provider: NuGet api_key: - secure: N59tiJECUYpip6tEn0xvdmDAEiP9SIzyLEFLpwiigm/8WhJvBNs13QxzT1/3/JW/ + secure: K3/810hkTO6rd2AEHVkUQAadjGmDREus9k96QHu6hxrA1/wRTuAJemHMKtVVgIvf skip_symbols: true on: branch: /^(master|dev)$/ From e44e591c5e7497404daa32e3014ae534372a31bc Mon Sep 17 00:00:00 2001 From: Rafael Cordeiro Date: Wed, 22 Jul 2020 00:39:42 -0700 Subject: [PATCH 15/29] Improve XML Docs --- .../FileLoggerConfigurationExtensions.cs | 54 +++++++++++++++++++ src/Serilog.Sinks.File/Sinks/File/FileSink.cs | 9 ++++ .../Sinks/File/PeriodicFlushToDiskSink.cs | 2 +- .../Sinks/File/SharedFileSink.AtomicAppend.cs | 8 +++ .../Sinks/File/SharedFileSink.OSMutex.cs | 8 +++ 5 files changed, 80 insertions(+), 1 deletion(-) diff --git a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs index 74383b2..d3e7d8f 100644 --- a/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs +++ b/src/Serilog.Sinks.File/FileLoggerConfigurationExtensions.cs @@ -14,6 +14,7 @@ using System; using System.ComponentModel; +using System.IO; using System.Text; using Serilog.Configuration; using Serilog.Core; @@ -238,6 +239,15 @@ public static LoggerConfiguration File( /// Ignored if is . /// The default is to retain files indefinitely. /// Configuration object allowing method chaining. + /// When is null + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, string path, @@ -299,6 +309,15 @@ public static LoggerConfiguration File( /// Ignored if is . /// The default is to retain files indefinitely. /// Configuration object allowing method chaining. + /// When is null + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid public static LoggerConfiguration File( this LoggerSinkConfiguration sinkConfiguration, ITextFormatter formatter, @@ -339,6 +358,14 @@ public static LoggerConfiguration File( /// the default is "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}". /// Configuration object allowing method chaining. /// The file will be written using the UTF-8 character set. + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid [Obsolete("New code should not be compiled against this obsolete overload"), EditorBrowsable(EditorBrowsableState.Never)] public static LoggerConfiguration File( this LoggerAuditSinkConfiguration sinkConfiguration, @@ -367,6 +394,15 @@ public static LoggerConfiguration File( /// to be changed at runtime. /// Configuration object allowing method chaining. /// The file will be written using the UTF-8 character set. + /// When is null + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid [Obsolete("New code should not be compiled against this obsolete overload"), EditorBrowsable(EditorBrowsableState.Never)] public static LoggerConfiguration File( this LoggerAuditSinkConfiguration sinkConfiguration, @@ -393,6 +429,15 @@ public static LoggerConfiguration File( /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Optionally enables hooking into log file lifecycle events. /// Configuration object allowing method chaining. + /// When is null + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid public static LoggerConfiguration File( this LoggerAuditSinkConfiguration sinkConfiguration, string path, @@ -428,6 +473,15 @@ public static LoggerConfiguration File( /// Character encoding used to write the text file. The default is UTF-8 without BOM. /// Optionally enables hooking into log file lifecycle events. /// Configuration object allowing method chaining. + /// When is null + /// When is null + /// When is null + /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid public static LoggerConfiguration File( this LoggerAuditSinkConfiguration sinkConfiguration, ITextFormatter formatter, diff --git a/src/Serilog.Sinks.File/Sinks/File/FileSink.cs b/src/Serilog.Sinks.File/Sinks/File/FileSink.cs index 451ba55..bc89ed9 100644 --- a/src/Serilog.Sinks.File/Sinks/File/FileSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/FileSink.cs @@ -44,7 +44,15 @@ public sealed class FileSink : IFileSink, IDisposable /// is false. /// Configuration object allowing method chaining. /// This constructor preserves compatibility with early versions of the public API. New code should not depend on this type. + /// When is null + /// When is null or less than 0 + /// When is null /// + /// + /// + /// When is too long + /// The caller does not have the required permission to access the + /// Invalid [Obsolete("This type and constructor will be removed from the public API in a future version; use `WriteTo.File()` instead.")] public FileSink(string path, ITextFormatter textFormatter, long? fileSizeLimitBytes, Encoding encoding = null, bool buffered = false) : this(path, textFormatter, fileSizeLimitBytes, encoding, buffered, null) @@ -113,6 +121,7 @@ bool IFileSink.EmitOrOverflow(LogEvent logEvent) /// Emit the provided log event to the sink. ///

/// The log event to write. + /// When is null public void Emit(LogEvent logEvent) { ((IFileSink) this).EmitOrOverflow(logEvent); diff --git a/src/Serilog.Sinks.File/Sinks/File/PeriodicFlushToDiskSink.cs b/src/Serilog.Sinks.File/Sinks/File/PeriodicFlushToDiskSink.cs index 66b0868..1b931c9 100644 --- a/src/Serilog.Sinks.File/Sinks/File/PeriodicFlushToDiskSink.cs +++ b/src/Serilog.Sinks.File/Sinks/File/PeriodicFlushToDiskSink.cs @@ -36,7 +36,7 @@ public class PeriodicFlushToDiskSink : ILogEventSink, IDisposable ///

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.