Add Method to 'FileUploadMonitor' to upload Summary.txt (#521)

* Add extra method to upload summary.txt

* add back in file header.

---------

Co-authored-by: CJ Hillbrand <cjhillbrand@microsoft.com>

Author: 2 people

VERSION

@@ -1 +1 @@
-2.0.20
+2.0.21

src/VirtualClient/VirtualClient.Core/Logging/SummaryFile/SummaryFileLogger.cs

@@ -57,7 +57,10 @@ public SummaryFileLogger(string filePath, IAsyncPolicy retryPolicy = null)
             if (string.IsNullOrWhiteSpace(filePath))
             {
                 PlatformSpecifics tempPlatformSpecifics = new PlatformSpecifics(Environment.OSVersion.Platform, RuntimeInformation.ProcessArchitecture);
-                filePath = tempPlatformSpecifics.Combine(tempPlatformSpecifics.LogsDirectory, "summary.txt");
+                ISystemInfo systemInfo = new SystemManagement();
+                string experimentId = systemInfo.ExperimentId;
+                string suffix = string.IsNullOrEmpty(experimentId) ? string.Empty : $"-{experimentId}";
+                filePath = tempPlatformSpecifics.Combine(tempPlatformSpecifics.LogsDirectory, $"summary{suffix}.txt");
             }
 
             this.filePath = filePath;

src/VirtualClient/VirtualClient.Monitors/FileUploadMonitor.cs

@@ -134,6 +134,9 @@ await this.Logger.LogMessageAsync($"{this.TypeName}.ProcessSummaryFileUploads",
                         // Upload the workload summary logs (e.g. metrics.csv) before exiting. We do this at the very end. Same as before, we do not
                         // honor the cancellation token until ALL files have been successfully processed.
                         await this.UploadCsvSummaryFilesAsync(blobManager, relatedContext);
+
+                        // Upload specific summary.txt at root level of logs directory.
+                        await this.UploadSummaryFileAsync(blobManager, relatedContext);
                     });
 
                     break;
@@ -233,6 +236,48 @@ private async Task<bool> UploadFilesAsync(IBlobManager blobManager, EventContext
             return filesFound;
         }
 
+        private async Task UploadSummaryFileAsync(IBlobManager blobManager, EventContext telemetryContext)
+        {
+            try
+            {
+                string suffix = string.IsNullOrEmpty(this.ExperimentId) ? string.Empty : $"-{this.ExperimentId}";
+                string summaryTxtFileLocation = Path.Combine(this.PlatformSpecifics.LogsDirectory, $"summary{suffix}.txt");
+                bool summaryTxtFileExists = this.fileSystem.File.Exists(summaryTxtFileLocation);
+                telemetryContext
+                    .AddContext(nameof(summaryTxtFileLocation), summaryTxtFileLocation)
+                    .AddContext(nameof(summaryTxtFileExists), summaryTxtFileExists);
+
+                if (summaryTxtFileExists)
+                {
+                    try
+                    {
+                        FileUploadDescriptor descriptor = this.CreateFileUploadDescriptor(
+                            new FileContext(
+                                this.fileSystem.FileInfo.New(summaryTxtFileLocation),
+                                "text/plain",
+                                Encoding.UTF8.WebName,
+                                this.ExperimentId,
+                                this.AgentId));
+
+                        await this.UploadFileAsync(blobManager, this.fileSystem, descriptor, CancellationToken.None);
+                    }
+                    catch (IOException exc) when (exc.Message.Contains("being used by another process", StringComparison.OrdinalIgnoreCase))
+                    {
+                        // It is common that there will be read/write access errors at certain times while
+                        // upload request files are being created at the same time as attempts to read. 
+                    }
+                    catch (Exception exc)
+                    {
+                        this.Logger.LogErrorMessage(exc, telemetryContext, LogLevel.Warning);
+                    }
+                }
+            }
+            catch (Exception exc)
+            {
+                this.Logger.LogErrorMessage(exc, telemetryContext, LogLevel.Error);
+            }
+        }
+
         private async Task UploadCsvSummaryFilesAsync(IBlobManager blobManager, EventContext telemetryContext)
         {
             try