Add some missing logging and telemetry handling

Author: baronfel

src/Containers/Microsoft.NET.Build.Containers/LocalDaemons/DockerCli.cs

@@ -51,6 +51,9 @@ public DockerCli(string? command, ILoggerFactory loggerFactory)
     public DockerCli(ILoggerFactory loggerFactory) : this(null, loggerFactory)
     { }
 
+    public bool IsDocker => _command == DockerCommand;
+    public bool IsPodman => _command == PodmanCommand;
+
     private static string FindFullPathFromPath(string command)
     {
         foreach (string directory in (Environment.GetEnvironmentVariable("PATH") ?? string.Empty).Split(Path.PathSeparator))

src/Containers/Microsoft.NET.Build.Containers/Tasks/DownloadLayers.cs

@@ -49,7 +49,7 @@ public async Task<bool> ExecuteAsync()
 
             if (string.IsNullOrEmpty(digest) || string.IsNullOrEmpty(size) || string.IsNullOrEmpty(mediaType))
             {
-                throw new ArgumentException($"Layer {layer.ItemSpec} must have Digest, Size, and MediaType metadata");
+                logger.LogError(new EventId(123456, "layer_item_validation_failure"), $"Layer {layer.ItemSpec} must have Digest, Size, and MediaType metadata");
             }
 
             var descriptor = new Descriptor(mediaType, digest, long.Parse(size));
@@ -58,18 +58,16 @@ public async Task<bool> ExecuteAsync()
                 {
                     if (t.IsFaulted)
                     {
-                        this.Log.LogError($"Failed to download layer {digest} from {Registry}/{Repository}: {t.Exception?.Flatten().Message}");
+                        logger.LogError(new EventId(123457, "layer_download_failure"), exception: t.Exception, $"Failed to download layer {digest} from {Registry}/{Repository}");
                     }
                     else if (t.IsCanceled)
                     {
-                        this.Log.LogError($"Failed to download layer {digest} from {Registry}/{Repository}: Task was cancelled");
+                        logger.LogError(new EventId(123457, "layer_download_failure"), exception: t.Exception, $"Failed to download layer {digest} from {Registry}/{Repository}");
                     }
                 })
             );
         }
         await Task.WhenAll(layerDownloadTasks);
-        return true;
+        return !Log.HasLoggedErrors;
     }
-
-    
 }

src/Containers/Microsoft.NET.Build.Containers/Tasks/MakeContainerTarball.cs

@@ -53,7 +53,9 @@ public async Task<bool> ExecuteAsync()
         var filePath = DetermineFilePath();
         await using var fileStream = File.Create(filePath);
         GeneratedArchiveFilePath = filePath;
+        var telemetry = new Telemetry(new(null, null, null, Telemetry.LocalStorageType.Tarball), Log);
         await DockerCli.WriteImageToStreamAsync(Repository, Tags, config!, layers, manifestStructure, fileStream, _cts.Token);
+        telemetry.LogPublishSuccess();
         return true;
     }
 

src/Containers/Microsoft.NET.Build.Containers/Tasks/PushContainerToLocal.cs

@@ -46,8 +46,34 @@ public async Task<bool> ExecuteAsync()
         var configDigest = manifestStructure.Config.digest;
         var config = await JsonSerializer.DeserializeAsync<JsonObject>(File.OpenRead(Configuration.ItemSpec), cancellationToken: _cts.Token);
         var containerCli = new DockerCli(LocalRegistry, msbuildLoggerFactory);
+
+        var telemetry = new Telemetry(new(null, null, null, containerCli.IsDocker ? Telemetry.LocalStorageType.Docker : Telemetry.LocalStorageType.Podman), Log);
+        if (!await containerCli.IsAvailableAsync(_cts.Token).ConfigureAwait(false))
+        {
+            telemetry.LogMissingLocalBinary();
+            Log.LogErrorWithCodeFromResources(nameof(Strings.LocalRegistryNotAvailable));
+            return false;
+        }
+
         var layers = Layers.Select(l => new Layer(new(l.ItemSpec), GetDescriptor(l))).ToArray();
-        await containerCli.LoadAsync((Repository, Tags, configDigest, config!, layers), DockerCli.WriteDockerImageToStreamAsync, _cts.Token);
+        try
+        {
+            await containerCli.LoadAsync((Repository, Tags, configDigest, config!, layers), DockerCli.WriteDockerImageToStreamAsync, _cts.Token);
+        }
+        catch (AggregateException ex) when (ex.InnerException is DockerLoadException dle)
+        {
+            telemetry.LogLocalLoadError();
+            Log.LogErrorFromException(dle, showStackTrace: false);
+        }
+        catch (ArgumentException argEx)
+        {
+            Log.LogErrorFromException(argEx, showStackTrace: false);
+        }
+        catch (DockerLoadException dle)
+        {
+            telemetry.LogLocalLoadError();
+            Log.LogErrorFromException(dle, showStackTrace: false);
+        }
         return true;
     }
 

src/Containers/Microsoft.NET.Build.Containers/Tasks/PushContainerToRemoteRegistry.cs

@@ -43,6 +43,7 @@ public async Task<bool> ExecuteAsync()
         ILogger logger = msbuildLoggerFactory.CreateLogger(nameof(PushContainerToRemoteRegistry));
         var destinationRegistry = new Registry(Registry, msbuildLoggerFactory.CreateLogger(Registry), RegistryMode.Push);
 
+        var telemetry = new Telemetry(new(null, null, Telemetry.GetRegistryType(destinationRegistry), null), Log);
         // functionally, we need to
         // * upload the layers
         var layerUploadTasks = Layers.Select(l => new Layer(new(l.ItemSpec), GetDescriptor(l))).Select(async l =>
@@ -124,6 +125,7 @@ public async Task<bool> ExecuteAsync()
             await destinationRegistry.UploadManifestAsync(Repository, tag, manifestStructure, _cts.Token);
             logger.LogInformation(Strings.Registry_TagUploaded, tag, Registry);
         }
+        telemetry.LogPublishSuccess();
         return true;
     }
 

src/Containers/Microsoft.NET.Build.Containers/Tasks/SelectRuntimeIdentifierSpecificItems.cs

@@ -32,20 +32,23 @@ public override bool Execute()
         ILoggerFactory msbuildLoggerFactory = new LoggerFactory(new[] { loggerProvider });
         ILogger logger = msbuildLoggerFactory.CreateLogger<CreateImageIndex>();
         var graph = NuGet.RuntimeModel.JsonRuntimeFormat.ReadRuntimeGraph(RuntimeIdentifierGraphPath);
-        
+
         var selectedItems = new List<ITaskItem>(Items.Length);
         foreach (var item in Items)
         {
-            if (item.GetMetadata("RuntimeIdentifier") is string ridValue && 
+            if (item.GetMetadata("RuntimeIdentifier") is string ridValue &&
                 graph.AreCompatible(TargetRuntimeIdentifier, ridValue))
             {
                 selectedItems.Add(item);
             }
         }
 
+        // TODO: log if no items were selected
+        // TODO: log telemetry.LogRidMismatch
+
         SelectedItems = selectedItems.ToArray();
         return true;
     }
 
-    
+
 }

src/Containers/Microsoft.NET.Build.Containers/Telemetry.cs

@@ -15,27 +15,33 @@ internal class Telemetry
     /// <param name="LocalPullType">If the base image came from a local store of some kind, what kind of store was it?</param>
     /// <param name="RemotePushType">If the new image is being pushed to a remote registry, what kind of registry is it?</param>
     /// <param name="LocalPushType">If the new image is being stored in a local store of some kind, what kind of store is it?</param>
-    private record class PublishTelemetryContext(RegistryType? RemotePullType, LocalStorageType? LocalPullType, RegistryType? RemotePushType, LocalStorageType? LocalPushType);
-    private enum RegistryType { Azure, AWS, Google, GitHub, DockerHub, MCR, Other }
-    private enum LocalStorageType { Docker, Podman, Tarball }
+    internal record class PublishTelemetryContext(RegistryType? RemotePullType, LocalStorageType? LocalPullType, RegistryType? RemotePushType, LocalStorageType? LocalPushType);
+    internal enum RegistryType { Azure, AWS, Google, GitHub, DockerHub, MCR, Other }
+    internal enum LocalStorageType { Docker, Podman, Tarball }
 
     private readonly Microsoft.Build.Utilities.TaskLoggingHelper Log;
     private readonly PublishTelemetryContext Context;
 
     internal Telemetry(
         SourceImageReference source,
         DestinationImageReference destination,
-        Microsoft.Build.Utilities.TaskLoggingHelper Log)
+        Microsoft.Build.Utilities.TaskLoggingHelper log)
     {
-        this.Log = Log;
+        Log = log;
         Context = new PublishTelemetryContext(
             source.Registry is not null ? GetRegistryType(source.Registry) : null,
             null, // we don't support local pull yet, but we may in the future
             destination.RemoteRegistry is not null ? GetRegistryType(destination.RemoteRegistry) : null,
             destination.LocalRegistry is not null ? GetLocalStorageType(destination.LocalRegistry) : null);
     }
 
-    private RegistryType GetRegistryType(Registry r)
+    internal Telemetry(PublishTelemetryContext context, Microsoft.Build.Utilities.TaskLoggingHelper log)
+    {
+        Log = log;
+        Context = context;
+    }
+
+    internal static RegistryType GetRegistryType(Registry r)
     {
         if (r.IsMcr) return RegistryType.MCR;
         if (r.IsGithubPackageRegistry) return RegistryType.GitHub;
@@ -113,4 +119,4 @@ public void LogLocalLoadError()
         props.Add("error", "local_load");
         Log.LogTelemetry("sdk/container/publish/error", props);
     }
-}
+}