Merge pull request #299 from DougSchmidt-AI/feature/PF-1405-PointZillaLogPointTimeRange

PF-1405 - Apply consistent summary of points and their time-ranges

Author: Doug Schmidt

TimeSeries/PublicApis/SdkExamples/PointZilla/CsvWriter.cs

@@ -32,7 +32,7 @@ public void WritePoints(List<TimeSeriesPoint> points, List<TimeSeriesNote> notes
                 ? Path.Combine(Context.SaveCsvPath, SanitizeFilename($"{timeSeriesIdentifier.Identifier}.{CreatePeriod(Context.SourceQueryFrom, Context.SourceQueryTo)}.csv"))
                 : Context.SaveCsvPath;
 
-            Log.Info($"Saving {"extracted point".ToQuantity(points.Count)} to '{csvPath}' ...");
+            Log.Info($"Saving {PointSummarizer.Summarize(points, "extracted point")} to '{csvPath}' ...");
 
             var dir = Path.GetDirectoryName(csvPath);
 

TimeSeries/PublicApis/SdkExamples/PointZilla/PointReaders/CsvReader.cs

@@ -98,7 +98,7 @@ private List<TimeSeriesPoint> LoadPoints(string path)
                 }
             }
 
-            Log.Info($"Loaded {"point".ToQuantity(points.Count)} from '{path}'.");
+            Log.Info($"Loaded {PointSummarizer.Summarize(points, "point")} from '{path}'.");
 
             return points;
         }

TimeSeries/PublicApis/SdkExamples/PointZilla/PointReaders/DbPointsReader.cs

@@ -46,7 +46,7 @@ public DbPointsReader(Context context)
 
                 var notes = LoadNotes(dbClient);
 
-                Log.Info($"Loaded {"point".ToQuantity(points.Count)} and {"note".ToQuantity(notes.Count)} from the database source.");
+                Log.Info($"Loaded {PointSummarizer.Summarize(points)} and {"note".ToQuantity(notes.Count)} from the database source.");
 
                 return (points, notes);
             }

TimeSeries/PublicApis/SdkExamples/PointZilla/PointReaders/ExternalPointsReader.cs

@@ -106,7 +106,7 @@ private List<TimeSeriesPoint> LoadPointsFromNg(IAquariusClient client)
                 gapTolerance,
                 interpolationType);
 
-            Log.Info($"Loaded {"point".ToQuantity(points.Count)} and {"note".ToQuantity(Notes.Count)} from {timeSeriesInfo.Identifier}");
+            Log.Info($"Loaded {PointSummarizer.Summarize(points)} and {"note".ToQuantity(Notes.Count)} from {timeSeriesInfo.Identifier}");
 
             return points;
         }
@@ -346,7 +346,7 @@ private List<TimeSeriesPoint> LoadPointsFrom3X(IAquariusClient client)
                 Notes.AddRange(corrections.Select(c => Convert3XCorrection(utcTimespan, c)));
             }
 
-            Log.Info($"Loaded {"point".ToQuantity(points.Count)} and {"note".ToQuantity(Notes.Count)} from {Context.SourceTimeSeries.Identifier}");
+            Log.Info($"Loaded {PointSummarizer.Summarize(points)} and {"note".ToQuantity(Notes.Count)} from {Context.SourceTimeSeries.Identifier}");
 
             return points;
         }

TimeSeries/PublicApis/SdkExamples/PointZilla/PointReaders/PointSummarizer.cs

@@ -0,0 +1,19 @@
+using System.Collections.Generic;
+using System.Linq;
+using Aquarius.TimeSeries.Client.ServiceModels.Acquisition;
+using Humanizer;
+
+namespace PointZilla.PointReaders
+{
+    public static class PointSummarizer
+    {
+        public static string Summarize(List<TimeSeriesPoint> points, string label = "point")
+        {
+            var pointExtents = points.Any()
+                ? $" [{points.First().Time} to {points.Last().Time}]"
+                : "";
+
+            return $"{label.ToQuantity(points.Count)}{pointExtents}";
+        }
+    }
+}

TimeSeries/PublicApis/SdkExamples/PointZilla/PointZilla.csproj

@@ -182,6 +182,7 @@
     <Compile Include="PointReaders\IPointReader.cs" />
     <Compile Include="PointReaders\MetadataLookup.cs" />
     <Compile Include="PointReaders\PointReaderBase.cs" />
+    <Compile Include="PointReaders\PointSummarizer.cs" />
     <Compile Include="SaveNotesMode.cs" />
     <Compile Include="TextGenerator.cs" />
     <Compile Include="TimeSeriesCreator.cs" />

TimeSeries/PublicApis/SdkExamples/PointZilla/PointsAppender.cs

@@ -88,15 +88,11 @@ public void AppendPoints()
                     }
                 }
 
-                var pointExtents = Points.Any()
-                    ? $" [{Points.First().Time} to {Points.Last().Time}]"
-                    : "";
-
                 Log.Info(Context.Command == CommandType.DeleteAllPoints
                     ? $"Deleting all existing points from {timeSeries.Identifier} ({timeSeries.TimeSeriesType}) ..."
                     : hasTimeRange
-                        ? $"Appending {"point".ToQuantity(Points.Count)} {pointExtents} within TimeRange={GetTimeRange()} to {timeSeries.Identifier} ({timeSeries.TimeSeriesType}) ..."
-                        : $"Appending {"point".ToQuantity(Points.Count)} {pointExtents} to {timeSeries.Identifier} ({timeSeries.TimeSeriesType}) ...");
+                        ? $"Appending {PointSummarizer.Summarize(Points)} within TimeRange={GetTimeRange()} to {timeSeries.Identifier} ({timeSeries.TimeSeriesType}) ..."
+                        : $"Appending {PointSummarizer.Summarize(Points)} to {timeSeries.Identifier} ({timeSeries.TimeSeriesType}) ...");
 
                 var numberOfPointsAppended = 0;
                 var numberOfPointsDeleted = 0;
@@ -113,7 +109,7 @@ public void AppendPoints()
                     if (isBatched)
                     {
                         var batchSummary =
-                            $"Appending batch #{batchIndex}: {"point".ToQuantity(batch.Points.Count)} [{batch.Points.First().Time} to {batch.Points.Last().Time}]";
+                            $"Appending batch #{batchIndex}: {PointSummarizer.Summarize(batch.Points)}";
 
                         Log.Info( hasTimeRange
                             ? $"{batchSummary} within TimeRange={batch.TimeRange} ..."

TimeSeries/PublicApis/SdkExamples/PointZilla/TextGenerator.cs

@@ -5,6 +5,7 @@
 using Aquarius.TimeSeries.Client.ServiceModels.Acquisition;
 using Humanizer;
 using NodaTime;
+using PointZilla.PointReaders;
 using ServiceStack.Logging;
 
 namespace PointZilla
@@ -66,7 +67,7 @@ public List<TimeSeriesPoint> GeneratePoints()
                 x += symbol.Width * Context.WaveformScalar;
             }
 
-            Log.Info($"Generated {"vector-text point".ToQuantity(points.Count)}. Scatter-plot X vs Y to read the message.");
+            Log.Info($"Generated {PointSummarizer.Summarize(points, "vector-text point")}. Scatter-plot X vs Y to read the message.");
 
             return points;
         }