Migrate to Microsoft.Extensions.Logging by lbussell · Pull Request #1968 · dotnet/docker-tools

lbussell · 2026-02-13T22:39:47Z

Part 1/2 of #1908 - Migrate to M.E.Logging.

Removed our ad-hoc logger setup. Use the default M.E.Logging setup provided by M.E.Hosting instead.
All classes/serivces now take ILogger<T> logger parameters and have a private _logger field.

Everything is [Info] level right now. We can adjust later as we go.

TODO (before merging):

Ensure Azure Pipelines logging directives still work
Remove instances of protected loggers in favor of private instead

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

This pull request migrates ImageBuilder from a custom ad-hoc logging system (ILoggerService/Logger) to Microsoft.Extensions.Logging as part 1/2 of issue #1908 to support structured logging. The migration replaces all instances of ILoggerService with ILogger from Microsoft.Extensions.Logging, removes the custom Logger and LoggerService classes, and introduces StandaloneLoggerFactory for static code paths that cannot use dependency injection.

Changes:

Replaced custom ILoggerService interface and implementation with Microsoft.Extensions.Logging.ILogger
Added StandaloneLoggerFactory for static contexts where DI isn't available
Updated all services, commands, and utilities to accept ILogger via constructor injection
Migrated all logging calls from custom methods (WriteMessage, WriteError, WriteHeading) to standard ILogger methods (LogInformation, LogError)
Updated test mocks from ILoggerService to ILogger

Reviewed changes

Copilot reviewed 80 out of 80 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
GlobalUsings.cs	Adds global using for Microsoft.Extensions.Logging
StandaloneLoggerFactory.cs	New factory providing logger access for static code paths
ImageBuilder.cs	Removes ILoggerService service registration
Logger.cs, LoggerService.cs, ILoggerService.cs	Removed custom logging infrastructure
RetryHelper.cs	Updated to use ILogger instead of ILoggerService
Program.cs	Enhanced error handling using ILoggerFactory
Services/*.cs	Migrated all services to use ILogger or ILoggerFactory
Commands/*.cs	Migrated all commands to use ILogger
Tests/*.cs	Updated all test mocks from ILoggerService to ILogger

Copilot · 2026-02-14T01:44:20Z

src/ImageBuilder/Commands/GenerateEolAnnotationDataCommandBase.cs

    }

-    protected ILoggerService LoggerService { get; }
+    protected ILogger LoggerService { get; }


According to the PR TODO, protected loggers should be changed to private. This protected ILogger LoggerService property should be private readonly ILogger _logger to follow the convention established in other migrated classes. Additionally, the property name should match the constructor parameter type (ILogger) rather than resembling the old ILoggerService.

Copilot · 2026-02-14T01:44:20Z

src/ImageBuilder/Commands/BuildCommand.cs

        private readonly IDockerService _dockerService;
-        private readonly ILoggerService _loggerService;
+        private readonly ILogger<BuildCommand> _logger;
+        private ILogger Logger => _logger;


This property wrapper private ILogger Logger => _logger; is unnecessary. The _logger field can be used directly throughout the class, which would be more consistent with how other classes in this migration use loggers. This adds an extra layer of indirection without clear benefit.

Copilot · 2026-02-14T01:44:20Z

src/ImageBuilder/MarImageIngestionReporter.cs

+        ILogger<MarImageIngestionReporter> logger,
+        ILoggerFactory loggerFactory,


The constructor accepts an unused logger parameter but never assigns it. The _loggerFactory field is used instead to create loggers later. Either remove the unused logger parameter or use it if it's needed.

Copilot · 2026-02-14T01:44:20Z

src/ImageBuilder/RetryHelper.cs

            {
-                loggerService.WriteError(exception.ToString());
-                LogRetryMessage(loggerService, timeToNextRetry, retryCount, maxRetries);
+                logger.LogError(exception.ToString());


The LogError calls should use the structured logging overload that accepts an exception as the first parameter. Instead of logger.LogError(exception.ToString()), use logger.LogError(exception, "message") to properly capture exception information in structured logs.

Copilot · 2026-02-14T01:44:21Z

src/ImageBuilder/LifecycleMetadataService.cs

        catch (InvalidOperationException ex)
        {
-            loggerService.WriteError($"Failed to annotate EOL for digest '{digest}': {ex.Message}");
+            logger.LogError($"Failed to annotate EOL for digest '{digest}': {ex.Message}");


The LogError calls should use the structured logging overload that accepts an exception as the first parameter. Instead of logger.LogError($"Failed to annotate EOL for digest '{digest}': {ex.Message}"), use logger.LogError(ex, $"Failed to annotate EOL for digest '{digest}'") to properly capture exception information in structured logs.

Copilot · 2026-02-14T01:44:21Z

src/ImageBuilder/Commands/GenerateArtifactsCommand.cs

+                Logger.LogError($"""
                    Template parsing error in file {templatePath}:{startLine},{startColumn},{endLine},{endColumn}
                    Message: {e.Message}


The LogError call should use the structured logging overload that accepts an exception as the first parameter. Change this to use a proper structured logging pattern that captures the exception object rather than converting it to a string.

Copilot · 2026-02-14T01:44:21Z

src/ImageBuilder/Commands/GenerateBuildMatrixCommand.cs

        private readonly IImageCacheService _imageCacheService;
-        private readonly ILoggerService _loggerService;
+        private readonly ILogger<GenerateBuildMatrixCommand> _logger;
+        private ILogger Logger => _logger;


This property wrapper private ILogger Logger => _logger; is unnecessary. The _logger field can be used directly throughout the class, which would be more consistent with how other classes in this migration use loggers. This adds an extra layer of indirection without clear benefit.

Copilot · 2026-02-14T01:44:22Z

src/ImageBuilder/CopyImageService.cs

+                string errorMsg = $"Importing Failure: {formattedDestinationImages}";
+                errorMsg += Environment.NewLine + e.ToString();
+
+                _logger.LogInformation(errorMsg);


The error message is being logged with LogInformation instead of LogError. This should be _logger.LogError(errorMsg) or better yet, use the exception overload: _logger.LogError(e, "Importing Failure: {DestinationImages}", formattedDestinationImages).

Copilot · 2026-02-14T01:44:22Z

src/ImageBuilder/Commands/CopyImagesCommand.cs

    private readonly ICopyImageService _copyImageService = copyImageService;

-    protected ILoggerService LoggerService { get; } = loggerService;
+    protected ILogger LoggerService { get; } = logger;


According to the PR TODO, protected loggers should be changed to private. This protected ILogger LoggerService property should be private readonly ILogger _logger to follow the convention established in other migrated classes. Additionally, the property name should match the constructor parameter type (ILogger) rather than resembling the old ILoggerService.

Copilot · 2026-02-14T01:44:22Z

src/ImageBuilder/Commands/GenerateArtifactsCommand.cs

        private TimeSpan _artifactGenerationTime = TimeSpan.Zero;

-        protected GenerateArtifactsCommand(IEnvironmentService environmentService) : base()
+        protected ILogger Logger { get; }


According to the PR TODO, protected loggers should be changed to private. This protected ILogger Logger property should be private readonly ILogger _logger to follow the convention established in other migrated classes and to adhere to the least-exposure rule.

mthalman

Also follow up on Copilot comments.

lbussell and others added 7 commits February 13, 2026 10:36

Migrate to Microsoft.Extensions.Logging

7a4ab2c

Use typed loggers

9e766fb

Reorder usings

88b71a4

Normalize logger types, field names, and parameter names

3e5f4cb

Use LoggerFactory where possible

868b84b

Merge upstream/main into logging

7f9f4dc

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add documentation to StandaloneLoggerFactory

ea16905

lbussell requested a review from a team as a code owner February 13, 2026 22:39

lbussell requested a review from Copilot February 14, 2026 01:41

Copilot started reviewing on behalf of lbussell February 14, 2026 01:41 View session

Copilot AI reviewed Feb 14, 2026

View reviewed changes

mthalman approved these changes Feb 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to Microsoft.Extensions.Logging#1968

Migrate to Microsoft.Extensions.Logging#1968
lbussell wants to merge 7 commits intodotnet:mainfrom
lbussell:logging

lbussell commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

Copilot AI Feb 14, 2026

Uh oh!

mthalman left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		ILogger<MarImageIngestionReporter> logger,
		ILoggerFactory loggerFactory,

Conversation

lbussell commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

mthalman left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants