[Exporter.OpenTelemetry.Protocol] update PersistentStorage (#6249)

Author: Kielek

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/DirectorySizeTracker.cs

@@ -56,16 +56,16 @@ internal static long CalculateFolderSize(string path)
         long directorySize = 0;
         try
         {
-            foreach (string file in Directory.EnumerateFiles(path))
+            foreach (var file in Directory.EnumerateFiles(path))
             {
                 if (File.Exists(file))
                 {
-                    FileInfo fileInfo = new FileInfo(file);
+                    var fileInfo = new FileInfo(file);
                     directorySize += fileInfo.Length;
                 }
             }
 
-            foreach (string dir in Directory.GetDirectories(path))
+            foreach (var dir in Directory.GetDirectories(path))
             {
                 directorySize += CalculateFolderSize(dir);
             }

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/FileBlob.cs

@@ -58,7 +58,7 @@ protected override bool OnTryWrite(byte[] buffer, int leasePeriodMilliseconds =
     {
         Guard.ThrowIfNull(buffer);
 
-        string path = this.FullPath + ".tmp";
+        var path = this.FullPath + ".tmp";
 
         try
         {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/FileBlobProvider.cs

@@ -5,7 +5,6 @@
 using System.Timers;
 using OpenTelemetry.Internal;
 using OpenTelemetry.PersistentStorage.Abstractions;
-using Timer = System.Timers.Timer;
 
 namespace OpenTelemetry.PersistentStorage.FileSystem;
 
@@ -24,7 +23,7 @@ public class FileBlobProvider : PersistentBlobProvider, IDisposable
     private readonly DirectorySizeTracker directorySizeTracker;
     private readonly long retentionPeriodInMilliseconds;
     private readonly int writeTimeoutInMilliseconds;
-    private readonly Timer maintenanceTimer;
+    private readonly System.Timers.Timer maintenanceTimer;
     private bool disposedValue;
 
     /// <summary>
@@ -61,7 +60,7 @@ public class FileBlobProvider : PersistentBlobProvider, IDisposable
     /// path exceeds system defined maximum length.
     /// </exception>
     /// <exception cref="UnauthorizedAccessException">
-    /// insufficient priviledges for provided path.
+    /// insufficient privileges for provided path.
     /// </exception>
     /// <exception cref="NotSupportedException">
     /// path contains a colon character (:) that is not part of a drive label ("C:\").
@@ -87,7 +86,7 @@ public FileBlobProvider(
         this.retentionPeriodInMilliseconds = retentionPeriodInMilliseconds;
         this.writeTimeoutInMilliseconds = writeTimeoutInMilliseconds;
 
-        this.maintenanceTimer = new Timer(maintenancePeriodInMilliseconds);
+        this.maintenanceTimer = new System.Timers.Timer(maintenancePeriodInMilliseconds);
         this.maintenanceTimer.Elapsed += this.OnMaintenanceEvent;
         this.maintenanceTimer.AutoReset = true;
         this.maintenanceTimer.Enabled = true;
@@ -105,7 +104,7 @@ protected override IEnumerable<PersistentBlob> OnGetBlobs()
 
         foreach (var file in Directory.EnumerateFiles(this.DirectoryPath, "*.blob", SearchOption.TopDirectoryOnly).OrderByDescending(f => f))
         {
-            DateTime fileDateTime = PersistentStorageHelper.GetDateTimeFromBlobName(file);
+            var fileDateTime = PersistentStorageHelper.GetDateTimeFromBlobName(file);
             if (fileDateTime > retentionDeadline)
             {
                 yield return new FileBlob(file, this.directorySizeTracker);
@@ -174,7 +173,7 @@ private void OnMaintenanceEvent(object? source, ElapsedEventArgs e)
 
     private bool CheckStorageSize()
     {
-        if (!this.directorySizeTracker.IsSpaceAvailable(out long size))
+        if (!this.directorySizeTracker.IsSpaceAvailable(out var size))
         {
             // TODO: check accuracy of size reporting.
             PersistentStorageEventSource.Log.PersistentStorageWarning(
@@ -186,7 +185,7 @@ private bool CheckStorageSize()
         return true;
     }
 
-    private PersistentBlob? CreateFileBlob(byte[] buffer, int leasePeriodMilliseconds = 0)
+    private FileBlob? CreateFileBlob(byte[] buffer, int leasePeriodMilliseconds = 0)
     {
         if (!this.CheckStorageSize())
         {
@@ -198,14 +197,7 @@ private bool CheckStorageSize()
             var blobFilePath = Path.Combine(this.DirectoryPath, PersistentStorageHelper.GetUniqueFileName(".blob"));
             var blob = new FileBlob(blobFilePath, this.directorySizeTracker);
 
-            if (blob.TryWrite(buffer, leasePeriodMilliseconds))
-            {
-                return blob;
-            }
-            else
-            {
-                return null;
-            }
+            return blob.TryWrite(buffer, leasePeriodMilliseconds) ? blob : null;
         }
         catch (Exception ex)
         {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/PersistentBlobProvider.cs

@@ -102,12 +102,12 @@ public IEnumerable<PersistentBlob> GetBlobs()
     {
         try
         {
-            return this.OnGetBlobs() ?? Enumerable.Empty<PersistentBlob>();
+            return this.OnGetBlobs() ?? [];
         }
         catch (Exception ex)
         {
             PersistentStorageAbstractionsEventSource.Log.PersistentStorageAbstractionsException(nameof(PersistentBlobProvider), "Failed to get all the blobs", ex);
-            return Enumerable.Empty<PersistentBlob>();
+            return [];
         }
     }
 

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/PersistentStorageAbstractionsEventSource.cs

@@ -9,7 +9,7 @@ namespace OpenTelemetry.PersistentStorage.Abstractions;
 [EventSource(Name = EventSourceName)]
 internal sealed class PersistentStorageAbstractionsEventSource : EventSource
 {
-    public static readonly PersistentStorageAbstractionsEventSource Log = new PersistentStorageAbstractionsEventSource();
+    public static PersistentStorageAbstractionsEventSource Log = new PersistentStorageAbstractionsEventSource();
 #if BUILDING_INTERNAL_PERSISTENT_STORAGE
     private const string EventSourceName = "OpenTelemetry-PersistentStorage-Abstractions-Otlp";
 #else

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/PersistentStorageEventSource.cs

@@ -9,7 +9,7 @@ namespace OpenTelemetry.PersistentStorage.FileSystem;
 [EventSource(Name = EventSourceName)]
 internal sealed class PersistentStorageEventSource : EventSource
 {
-    public static readonly PersistentStorageEventSource Log = new PersistentStorageEventSource();
+    public static PersistentStorageEventSource Log = new PersistentStorageEventSource();
 #if BUILDING_INTERNAL_PERSISTENT_STORAGE
     private const string EventSourceName = "OpenTelemetry-PersistentStorage-FileSystem-Otlp";
 #else

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/PersistentStorageHelper.cs

@@ -12,7 +12,7 @@ internal static void RemoveExpiredBlob(DateTime retentionDeadline, string filePa
     {
         if (filePath.EndsWith(".blob", StringComparison.OrdinalIgnoreCase))
         {
-            DateTime fileDateTime = GetDateTimeFromBlobName(filePath);
+            var fileDateTime = GetDateTimeFromBlobName(filePath);
             if (fileDateTime < retentionDeadline)
             {
                 try
@@ -30,11 +30,11 @@ internal static void RemoveExpiredBlob(DateTime retentionDeadline, string filePa
 
     internal static bool RemoveExpiredLease(DateTime leaseDeadline, string filePath)
     {
-        bool success = false;
+        var success = false;
 
         if (filePath.EndsWith(".lock", StringComparison.OrdinalIgnoreCase))
         {
-            DateTime fileDateTime = GetDateTimeFromLeaseName(filePath);
+            var fileDateTime = GetDateTimeFromLeaseName(filePath);
             if (fileDateTime < leaseDeadline)
             {
                 var newFilePath = filePath.Substring(0, filePath.LastIndexOf('@'));
@@ -55,11 +55,11 @@ internal static bool RemoveExpiredLease(DateTime leaseDeadline, string filePath)
 
     internal static bool RemoveTimedOutTmpFiles(DateTime timeoutDeadline, string filePath)
     {
-        bool success = false;
+        var success = false;
 
         if (filePath.EndsWith(".tmp", StringComparison.OrdinalIgnoreCase))
         {
-            DateTime fileDateTime = GetDateTimeFromBlobName(filePath);
+            var fileDateTime = GetDateTimeFromBlobName(filePath);
             if (fileDateTime < timeoutDeadline)
             {
                 try
@@ -144,7 +144,7 @@ internal static DateTime GetDateTimeFromLeaseName(string filePath)
     {
         var fileName = Path.GetFileNameWithoutExtension(filePath);
         var startIndex = fileName.LastIndexOf('@') + 1;
-        var time = fileName.Substring(startIndex, fileName.Length - startIndex);
+        var time = fileName.Substring(startIndex);
         DateTime.TryParseExact(time, "yyyy-MM-ddTHHmmss.fffffffZ", CultureInfo.InvariantCulture, DateTimeStyles.None, out var dateTime);
         return dateTime.ToUniversalTime();
     }

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/PersistentStorage/README.md

@@ -1,9 +1,9 @@
 # Persistent Storage APIs for OTLP Exporter
 
 The files in this folder have been copied over from
-[OpenTelemetry.PersistentStorage.Abstractions](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/58607b7cdeb15207027a6fa4ca56e7fac897bda4/src/OpenTelemetry.PersistentStorage.Abstractions)
+[OpenTelemetry.PersistentStorage.Abstractions](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/1be4157075ad09e13aa54b8e5845d2310bd82673/src/OpenTelemetry.PersistentStorage.Abstractions)
 and
-[OpenTelemetry.PersistentStorage.FileSystem](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/58607b7cdeb15207027a6fa4ca56e7fac897bda4/src/OpenTelemetry.PersistentStorage.FileSystem).
+[OpenTelemetry.PersistentStorage.FileSystem](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/1be4157075ad09e13aa54b8e5845d2310bd82673/src/OpenTelemetry.PersistentStorage.FileSystem).
 Any code changes in this folder MUST go through changes in the original location
 i.e. in the contrib repo. Here is the sequence of steps to be followed when
 making changes: