Added Support for the log appender roll-by-size-time to zip older files #259

DHirani · 2018-01-18T16:54:34Z

Two new elements introduced zipolderthannumdays and zipdateformat introduced so the older log files can be zipped up automatically at roll time when autoRollAtTime element is used.

1. logname - you can override the name of the log file rather than using the EXE name, this means you don't have to call your EXE a different name, just name the winsw exe different. Default's the name to the EXE as before. 2. outfiledisabled - you can disable writing to the out file. Defaults to false. 3. errfiledisabled - you can disable writing to the error file. Defaults to false. 4. outfilepattern - you can choose the pattern of the out file. Defaults to .out.log. 5. errfilepattern - you can choos the pattern of the error file. Defaults to .err.log.

…led and errfilepattern. Created a new appender called roll-by-size-time see class RollingSizeTimeLogAppender, this appender supports rolling by time and size and rolling at a specific time each day. Added unit test for the new appender. Added a new option testwait which is similar to test but waits for the user to press any key before calling the stop method.

oleg-nenashev

This pull request should also provide documentation for this new feature

oleg-nenashev · 2018-02-04T12:10:01Z

src/Core/ServiceWrapper_dotNET4/packages.config

  <package id="ILMerge" version="2.14.1208" targetFramework="net20" />
  <package id="log4net" version="2.0.8" targetFramework="net20" requireReinstallation="True" />
  <package id="MSBuildTasks" version="1.4.0.88" targetFramework="net20" />
-</packages>
+</packages>


hmm, would be better to revert

Need the library ICSharpCode.SharpZipLib.dll to carry out zipping as the core code is still using Framework 2.0 and the Zip classes are only available from .Net Framework 4.5 +

oleg-nenashev · 2018-02-04T12:10:52Z

src/Core/WinSWCore/LogAppenders.cs


-        public RollingSizeTimeLogAppender(string logDirectory, string baseName, bool outFileDisabled, bool errFileDisabled, string outFilePattern, string errFilePattern, int sizeThreshold, string filePattern, TimeSpan? autoRollAtTime)
+        public RollingSizeTimeLogAppender(string logDirectory, string baseName, bool outFileDisabled, bool errFileDisabled, string outFilePattern, string errFilePattern, int sizeThreshold, string filePattern, TimeSpan? autoRollAtTime, int? zipolderthannumdays, string zipdateformat)


fine, this project does not offer binary compatibility to API users so far

Documented the new fields zipolderthannumdays and zipdateformat

DHirani · 2018-02-05T08:58:03Z

Added documentation for the two new zip elements

DHirani · 2018-02-12T08:52:56Z

Please let me know if you are happy to merge this to master or if there are still any other outstanding issues

oleg-nenashev · 2018-02-12T09:09:38Z

Yes, I still need to review it. Sorry for the delays

oleg-nenashev

I am still drowning in the Jenkins project things, but I am more available now. Will do my best to finally test it. Some bits in docs should be fixed for sure though I agree there is no need to include it into the sample configurations provided in the project.

Bonus points for unit tests

oleg-nenashev · 2018-02-20T20:23:58Z

doc/loggingAndErrorReporting.md

@@ -56,6 +56,8 @@ Works in a combination of rotate size mode and rotate time mode, if the log file
      <sizeThreshold>10240</sizeThreshold>
      <pattern>yyyyMMdd</pattern>
      <autoRollAtTime>00:00:00</autoRollAtTime>
+      <zipolderthannumdays>5</zipolderthannumdays>


would it be possible to rename it to zipOlderThanNumDays for consistency?

oleg-nenashev · 2018-02-20T20:27:25Z

src/Core/WinSWCore/LogAppenders.cs

@@ -328,13 +329,17 @@ public class RollingSizeTimeLogAppender : AbstractFileLogAppender
        public int SizeTheshold { private set; get; }
        public string FilePattern { private set; get; }
        public TimeSpan? AutoRollAtTime { private set; get; }
+        public int? ZipOlderTthanNumDays { private set; get; }


Was it supposed to be ZipOlderThanNumDays?

oleg-nenashev · 2018-02-20T20:29:39Z

doc/loggingAndErrorReporting.md

@@ -65,6 +67,10 @@ For example, in the above example, the log of Jan 1, 2013 gets written to `myapp
 The syntax of the autoRollAtTime is specified by [TimeSpan.ToString()](https://msdn.microsoft.com/en-us/library/1ecy8h51(v=vs.110).aspx).
 For example, in the above example, at the start of the day it will roll the file over.

+The zipolderthannumdays can only be used in conjection with autoRollAtTime, provide the number of days of files to keep.


I would split it to a separate documentation section so that it becomes explicit that the vars are optional.
I do not see specific reason why it's not supported in other rotating loggers, but fine with me if documented separately

oleg-nenashev

LGTM as code. will do some manual testing and hopefully ship it next week

DHirani · 2018-03-27T12:31:00Z

Are you good to merge this into master?

oleg-nenashev · 2018-03-27T12:36:34Z

It's in my TODO list (somewhere on the top), I apologize for the delay. Unfortunately I have been unable to get to it yet, because it requires some spare time to test it + availability of a Windows development environment at the same time. So far I was unable to find time for that (Jenkins JEP-200, Google Summer of Code, etc.)

If anybody is waiting for this change to be shipped, please do not hesitate to test the build and to report results. It may speedup the process. P.S: I am also looking for co-maintainers

DHirani · 2018-03-27T12:53:47Z

I have built my own version but would be nice to take it from nuget in the future, whenever you get to it would be great

arijoon · 2018-04-24T16:23:20Z

src/Core/ServiceWrapper_dotNET4/packages.config

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="ICSharpCode.SharpZipLib.dll" version="0.85.4.369" targetFramework="net40" />


This needs to be added to the Merge configuration so it is linked in the final executable

Added to ServiceWrapper/packages.config as well, is that what you meant.

There is a ILMerge command in the csproj file's build section which links all the dlls into a single executable. This library needs to be referenced there. checkout winsw_dotNET4.csproj:142

Yes, now there is some duplication in configs now. It may be confusing, but ILMerge is the only way to get such executable with the current project layout and .NET2

Ok so this will be picked up automatically by ILMerge as it now added into the packages.config and referenced by winsw.csproj. There is nothing more for me to do, am I correct?

oleg-nenashev · 2018-06-19T16:38:53Z

Tested it locally on the weekend. Looks good.
Sorry for being non-responsive in the repo, I will try to catch-up

DHirani and others added 16 commits August 29, 2017 14:16

Downgraded from C#7.0 syntax.

cacc854

Applied reviewers comment

b26a4b6

not required

b1691b9

removed the key

f495418

Update loggingAndErrorReporting.md

01f5ad7

Cannot use $ string.format syntax, downgraded code to string.format.

bfa35d4

Merge branch 'master' of https://github.com/dhirani/winsw

694e67d

Another syntax found of $

2311d7b

Fixed a unit tests

90ada7e

test

43971d3

Added support to zip files.

08cbd3b

Added error handling

14c7826

Removed the zip call at startup.

ee5e980

Fix issue with UTC

6390294

oleg-nenashev requested changes Feb 4, 2018

View reviewed changes

DHirani added 2 commits February 5, 2018 08:56

Update loggingAndErrorReporting.md

1be0470

Documented the new fields zipolderthannumdays and zipdateformat

Update loggingAndErrorReporting.md

d8a074c

oleg-nenashev self-requested a review February 20, 2018 20:22

oleg-nenashev requested changes Feb 20, 2018

View reviewed changes

Applied Code review

0d6dee0

oleg-nenashev approved these changes Feb 26, 2018

View reviewed changes

oleg-nenashev self-assigned this Feb 26, 2018

Fixed a BST bug

158c83a

arijoon reviewed Apr 24, 2018

View reviewed changes

Added zip lib

4281f5b

oleg-nenashev merged commit 9014f38 into winsw:master Jun 19, 2018

nxtn added this to the 2.2.0 milestone Mar 25, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Support for the log appender roll-by-size-time to zip older files #259

Added Support for the log appender roll-by-size-time to zip older files #259

DHirani commented Jan 18, 2018 •

edited

oleg-nenashev left a comment

oleg-nenashev Feb 4, 2018

DHirani Feb 5, 2018 •

edited

oleg-nenashev Feb 4, 2018

DHirani commented Feb 5, 2018

DHirani commented Feb 12, 2018

oleg-nenashev commented Feb 12, 2018

oleg-nenashev left a comment

oleg-nenashev Feb 20, 2018

DHirani Feb 21, 2018

oleg-nenashev Feb 20, 2018

DHirani Feb 21, 2018

oleg-nenashev Feb 20, 2018

DHirani Feb 21, 2018

oleg-nenashev left a comment

DHirani commented Mar 27, 2018

oleg-nenashev commented Mar 27, 2018

DHirani commented Mar 27, 2018

arijoon Apr 24, 2018

DHirani Apr 25, 2018

arijoon Apr 25, 2018

oleg-nenashev Apr 25, 2018

DHirani Apr 26, 2018 •

edited

oleg-nenashev commented Jun 19, 2018


		public RollingSizeTimeLogAppender(string logDirectory, string baseName, bool outFileDisabled, bool errFileDisabled, string outFilePattern, string errFilePattern, int sizeThreshold, string filePattern, TimeSpan? autoRollAtTime)
		public RollingSizeTimeLogAppender(string logDirectory, string baseName, bool outFileDisabled, bool errFileDisabled, string outFilePattern, string errFilePattern, int sizeThreshold, string filePattern, TimeSpan? autoRollAtTime, int? zipolderthannumdays, string zipdateformat)

Added Support for the log appender roll-by-size-time to zip older files #259

Added Support for the log appender roll-by-size-time to zip older files #259

Conversation

DHirani commented Jan 18, 2018 • edited

oleg-nenashev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHirani Feb 5, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHirani commented Feb 5, 2018

DHirani commented Feb 12, 2018

oleg-nenashev commented Feb 12, 2018

oleg-nenashev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oleg-nenashev left a comment

Choose a reason for hiding this comment

DHirani commented Mar 27, 2018

oleg-nenashev commented Mar 27, 2018

DHirani commented Mar 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHirani Apr 26, 2018 • edited

Choose a reason for hiding this comment

oleg-nenashev commented Jun 19, 2018

DHirani commented Jan 18, 2018 •

edited

DHirani Feb 5, 2018 •

edited

DHirani Apr 26, 2018 •

edited