Added {Hour} and {HalfHour} specifiers. #29

jose3m · 2016-09-29T15:26:06Z

This PR corresponds to the issue #22 .

This development adds two new specifiers to the currently admitted {Date}: {Hour} and {HalfHour}
The behaviour is obvius.

Please, feel free to change the token {HalfHour} by the one you consider better (you only have to change the value of the constant TemplatedPathRoller.HalfHourSpecifier).

One thing to have in mind when using it is that the three specifiers shouldn't be used at the same or different time on the same path as it could be confusing with an unexpected result.

Thanks.
Jose

nblumhardt · 2016-09-30T06:20:10Z

Great! Thanks for the PR. It may take me a few days to work through it, just letting you know that it hasn't fallen off the radar :-)

jose3m · 2016-09-30T07:02:52Z

I'll be expecting it !

Thanks a lot.

nblumhardt

Looks great. Added a few comments. Thanks!

nblumhardt · 2016-10-03T23:03:04Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/RollingFileSink.cs


            // We only take one attempt at it because repeated failures
            // to open log files REALLY slow an app down.
-            _nextCheckpoint = date.AddDays(1);
+


Extra newline

Still an extra newline hanging around here.

nblumhardt · 2016-10-03T23:03:49Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/RollingFileSink.cs

@@ -140,13 +141,13 @@ void OpenFile(DateTime now)
            }
            catch (DirectoryNotFoundException) { }

-            var latestForThisDate = _roller
+            var latestForThisDateTime = _roller


Would it be clearer if we called this latestForThisCheckpoint?

Feel free to rename any field or constant.

nblumhardt · 2016-10-03T23:08:56Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

        const string DefaultSeparator = "-";

+        const string MatcherMarkSpecifier = "date";


Good idea pulling these out as constants 👍

Just on the naming, could we perhaps use:

const string SpecifierMatchGroup = "specifier"; const string SequenceNumberMatchGroup" = "sequence";

nblumhardt · 2016-10-03T23:09:29Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

        readonly string _pathTemplate;
        readonly Regex _filenameMatcher;
+        readonly SpecifierTypeEnum _specifierType = SpecifierTypeEnum.None;
+        // Concret used Date or Hour specifier.


Typo in this comment ("concret") - we could possibly drop the comment since the field names are pretty descriptive.

nblumhardt · 2016-10-03T23:11:42Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

        readonly string _pathTemplate;
        readonly Regex _filenameMatcher;
+        readonly SpecifierTypeEnum _specifierType = SpecifierTypeEnum.None;


Carrying both _specifierType and _usedSpecifier means the two could (potentially) be out-of-sync. What do you think about getting rid of the enum, and just using e.g. _usedSpecifier == HourSpecifier etc. as comparisons?

One other option that would work really well:

class Specifier { public string Name { get; } public string Token { get; } public string Format { get; } public TimeSpan Interval { get; } Specifier(string name, string format, string interval) { Name = name; Token = "{" + Name + "}"; Format = format; Interval = interval; } public static readonly Specifier Date = new Specifier("Date", "yyyyMMdd", TimeSpan.FromDays(1)); public static readonly Specifier Hour = new Specifier("Hour", "yyyyMMddhh", TimeSpan.FromHours(1)); public static readonly Specifier HalfHour = new Specifier("HalfHour", "yyyyMMddhhmm", TimeSpan.FromMinutes(30)); }

We could then have a field:

readonly Specifier _specifier;

Then, after construction, we could avoid checking the current specifier and just use fields like _specifier.Token, _specifier.Interval and so-on.

What do you think?

For me it is great to encapsulate the fields in a class.
I didn't want to make so much changes from the original source so the merge should be easier.
Feel free to make any change with which you feel more confortable.

nblumhardt · 2016-10-03T23:12:37Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

+
+    enum SpecifierTypeEnum


If we decide to keep the enum (see comment above), we should drop the Enum suffix. Just calling it Specifier would be clear enough.

I would prefer to use a class for the specifier. It is more OOP compliant.

nblumhardt · 2016-10-03T23:13:33Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

                }
            }
        }
+
+        public DateTime GetCurrentCheckpoint(DateTime date)


Could we call the parameter name instant or dateTime?

"instant" is nice for me. More descriptive than "datetime" or just "date".

nblumhardt · 2016-10-03T23:13:47Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

+            return date.Date;
+        }
+
+        public DateTime GetNextCheckpoint(DateTime date)


Parameter naming here also.

nblumhardt · 2016-10-04T07:33:09Z

Thanks for the replies @jose3m!

In the PR workflow, you can push additional changes to your repository and they'll appear here in the PR. (As the code's still on your side, I can't make changes to it "on the way in".)

Cheers,
Nick

jose3m · 2016-10-05T10:59:20Z

Hi Nick !

I have just commited the changes we talked about.
I have added more code to the Specifier class as it will be better encapsulated.

Thanks.
Jose

nblumhardt

Looks like we're getting close. Mostly stylistic feedback. There seem to be a few opportunities to encapsulate more in the Specifier class - what do you think? Cheers!

nblumhardt · 2016-10-06T05:41:25Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/RollingFileSink.cs


            // We only take one attempt at it because repeated failures
            // to open log files REALLY slow an app down.
-            _nextCheckpoint = date.AddDays(1);
+


Still an extra newline hanging around here.

nblumhardt · 2016-10-06T05:52:00Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/Specifier.cs

+
+namespace Serilog.Sinks.RollingFile.Sinks.RollingFile
+{
+    internal class Specifier


Nitpick - the codebase doesn't use explicit internal modifiers on types or private modifiers on members.

nblumhardt · 2016-10-06T05:57:04Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/Specifier.cs

+        internal static readonly TimeSpan HourInterval = TimeSpan.FromHours(1);
+        internal static readonly TimeSpan HalfHourInterval = TimeSpan.FromMinutes(30);
+
+        //-------------------


//---- and whitespace can probably go, not used through the rest of the Serilog codebase.

nblumhardt · 2016-10-06T05:59:00Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/Specifier.cs

+        public string Format { get; }
+        public TimeSpan Interval { get; }
+
+        Specifier(SpecifierType type)


It seems like SpecifierType only exists to use in this constructor. If the ctor took name, format and interval, we could get rid of SpecifierType and save quite a few LOC (including the switch statement).

SpecifierType is used also in the getCurrentCheckpoint function. I'll remove this enum and I'll use the token to identify what kind of specifier is the instance.

nblumhardt · 2016-10-06T06:00:35Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/Specifier.cs

+    {
+        internal const string OldStyleDateToken = "{0}";
+
+        internal const string DateToken = "{Date}";


It will be tidier to expose the specifiers instead, so these can just be Specifier.Date.Token.

I agree. I change it.

nblumhardt · 2016-10-06T06:03:37Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

-                throw new ArgumentException("The old-style date specifier " + OldStyleDateSpecifier +
-                    " is no longer supported, instead please use " + DateSpecifier);
+
+            if (pathTemplate.Contains(Specifier.OldStyleDateToken))


The next 13 lines could be encapsulated in Specifier.TryGetSpecifier(pathTemplate, out specifier). If it returns false, _specifier can be set to Specifier.Date and the path modified. TryGetSpecifier() could then also be used to avoid the chain of three if statements to decide whether it's included in the directory name.

nblumhardt · 2016-10-06T06:05:06Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

@@ -49,28 +65,42 @@ public TemplatedPathRoller(string pathTemplate)

            directory = Path.GetFullPath(directory);

-            if (directory.Contains(DateSpecifier))
+            if (directory.Contains(Specifier.DateToken))


E.g.

Specifier directorySpecifier; if (Specifier.TryGetSpecifier(directory, out directorySpecifier) { throw new ArgumentException($"The {directorySpecifer.Token} specifier cannot form part of the directory name."); }

nblumhardt · 2016-10-06T06:05:35Z

src/Serilog.Sinks.RollingFile/Sinks/RollingFile/TemplatedPathRoller.cs

@@ -81,12 +111,14 @@ public TemplatedPathRoller(string pathTemplate)

        public void GetLogFilePath(DateTime date, int sequenceNumber, out string path)
        {
-            var tok = date.ToString(DateFormat, CultureInfo.InvariantCulture);
+            DateTime currentCheckpoint = GetCurrentCheckpoint(date);


Nitpick, can use var here.

jose3m · 2016-10-06T09:42:03Z

Hi Nick !
Last changes are commited.

Even more encapsulating, it could be created a new static method inside Specifier containing all validations on the TemplatedPathRoller constructor, from line 42 to line 72.

Specifier.ValidateTemplate(string pathTemplate, out string directory)

Regards
Jose

nblumhardt · 2016-10-09T23:58:31Z

Thanks Jose! I will merge it now and have a tinker with the encapsulated validation myself. Cheers!

jose3m · 2016-10-10T07:30:54Z

Thank you very much for your great work !

jose3m added 2 commits September 29, 2016 17:10

Added {Hour} and {HalfHour} specifiers.

fc828dc

Update of test sources.

c7062a0

nblumhardt reviewed Oct 3, 2016

View reviewed changes

Changes.

5564c62

nblumhardt reviewed Oct 6, 2016

View reviewed changes

Second revision.

bbcfb67

nblumhardt merged commit a7a7a1d into serilog:dev Oct 9, 2016

nblumhardt mentioned this pull request Oct 10, 2016

Suggesting new feature: rolling file per {DateHour} #22

Closed

nblumhardt mentioned this pull request Oct 24, 2016

3.2.0 Release #35

Merged

		const string DefaultSeparator = "-";

		const string MatcherMarkSpecifier = "date";

Added {Hour} and {HalfHour} specifiers. #29

Added {Hour} and {HalfHour} specifiers. #29

Conversation

jose3m commented Sep 29, 2016

nblumhardt commented Sep 30, 2016

jose3m commented Sep 30, 2016

nblumhardt 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nblumhardt commented Oct 4, 2016

jose3m commented Oct 5, 2016

nblumhardt 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

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

Choose a reason for hiding this comment

jose3m commented Oct 6, 2016 • edited Loading

nblumhardt commented Oct 9, 2016

jose3m commented Oct 10, 2016 • edited Loading

jose3m commented Oct 6, 2016 •

edited

Loading

jose3m commented Oct 10, 2016 •

edited

Loading