Fix the logging pipeline so that logger provider filtering works (#12476)

* Fix the logging pipeline so that logger provider filtering works
- Including stack traces in logs of steps is another flag
- Step loggers are normal ILoggers and Logging to the current step is via an async local and PipelineLoggerProvider.

* Update src/Aspire.Hosting/Pipelines/PipelineLoggerProvider.cs

Co-authored-by: Copilot <[email protected]>

* Update src/Aspire.Hosting/Pipelines/PipelineLoggerProvider.cs

* Refactor pipeline activity reporting and command argument handling for improved clarity and functionality

---------

Co-authored-by: Copilot <[email protected]>

Author: davidfowl

src/Aspire.Cli/Commands/DeployCommand.cs

@@ -15,7 +15,6 @@ namespace Aspire.Cli.Commands;
 internal sealed class DeployCommand : PipelineCommandBase
 {
     private readonly Option<bool> _clearCacheOption;
-    private readonly Option<string?> _stepOption;
 
     public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext, ICliHostEnvironment hostEnvironment)
         : base("deploy", DeployCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext, hostEnvironment)
@@ -25,12 +24,6 @@ public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionSer
             Description = "Clear the deployment cache associated with the current environment and do not save deployment state"
         };
         Options.Add(_clearCacheOption);
-
-        _stepOption = new Option<string?>("--step")
-        {
-            Description = "Run a specific deployment step and its dependencies"
-        };
-        Options.Add(_stepOption);
     }
 
     protected override string OperationCompletedPrefix => DeployCommandStrings.OperationCompletedPrefix;
@@ -60,21 +53,16 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
             baseArgs.AddRange(["--log-level", logLevel!]);
         }
 
-        var environment = parseResult.GetValue(_environmentOption);
-        if (!string.IsNullOrEmpty(environment))
+        var includeExceptionDetails = parseResult.GetValue(_includeExceptionDetailsOption);
+        if (includeExceptionDetails)
         {
-            baseArgs.AddRange(["--environment", environment!]);
+            baseArgs.AddRange(["--include-exception-details", "true"]);
         }
 
-        var step = parseResult.GetValue(_stepOption);
-        if (step != null)
-        {
-            baseArgs.AddRange(["--step", step]);
-        }
-        else
+        var environment = parseResult.GetValue(_environmentOption);
+        if (!string.IsNullOrEmpty(environment))
         {
-            // Default to the "deploy" step
-            baseArgs.AddRange(["--step", "deploy"]);
+            baseArgs.AddRange(["--environment", environment!]);
         }
 
         baseArgs.AddRange(unmatchedTokens);
@@ -86,7 +74,6 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
 
     protected override string GetProgressMessage(ParseResult parseResult)
     {
-        var step = parseResult.GetValue(_stepOption);
-        return $"Executing step \"{step ?? "deploy"}\"";
+        return "Executing step deploy";
     }
 }

src/Aspire.Cli/Commands/DoCommand.cs

@@ -52,6 +52,12 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
             baseArgs.AddRange(["--log-level", logLevel!]);
         }
 
+        var includeExceptionDetails = parseResult.GetValue(_includeExceptionDetailsOption);
+        if (includeExceptionDetails)
+        {
+            baseArgs.AddRange(["--include-exception-details", "true"]);
+        }
+
         var environment = parseResult.GetValue(_environmentOption);
         if (!string.IsNullOrEmpty(environment))
         {
@@ -68,6 +74,6 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
     protected override string GetProgressMessage(ParseResult parseResult)
     {
         var step = parseResult.GetValue(_stepArgument);
-        return $"Executing step \"{step}\"";
+        return $"Executing step {step}";
     }
 }

src/Aspire.Cli/Commands/PipelineCommandBase.cs

@@ -34,6 +34,11 @@ internal abstract class PipelineCommandBase : BaseCommand
         Description = "Set the minimum log level for pipeline logging (trace, debug, information, warning, error, critical). The default is 'information'."
     };
 
+    protected readonly Option<bool> _includeExceptionDetailsOption = new("--include-exception-details")
+    {
+        Description = "Include exception details (stack traces) in pipeline logs."
+    };
+
     protected readonly Option<string?> _environmentOption = new("--environment", "-e")
     {
         Description = "The environment to use for the operation. The default is 'Production'."
@@ -82,6 +87,7 @@ protected PipelineCommandBase(string name, string description, IDotNetCliRunner
 
         Options.Add(_logLevelOption);
         Options.Add(_environmentOption);
+        Options.Add(_includeExceptionDetailsOption);
 
         // In the publish and deploy commands we forward all unrecognized tokens
         // through to the underlying tooling when we launch the app host.

src/Aspire.Cli/Commands/PublishCommand.cs

@@ -63,6 +63,12 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
             baseArgs.AddRange(["--log-level", logLevel!]);
         }
 
+        var includeExceptionDetails = parseResult.GetValue(_includeExceptionDetailsOption);
+        if (includeExceptionDetails)
+        {
+            baseArgs.AddRange(["--include-exception-details", "true"]);
+        }
+
         var environment = parseResult.GetValue(_environmentOption);
         if (!string.IsNullOrEmpty(environment))
         {
@@ -76,5 +82,5 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
 
     protected override string GetCanceledMessage() => InteractionServiceStrings.OperationCancelled;
 
-    protected override string GetProgressMessage(ParseResult parseResult) => "Executing step \"publish\"";
+    protected override string GetProgressMessage(ParseResult parseResult) => "Executing step publish";
 }

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

@@ -178,7 +178,7 @@ public void Continuation(string message)
         }
     }
 
-    public void WriteSummary(string? dashboardUrl = null)
+    public void WriteSummary()
     {
         lock (_lock)
         {
@@ -253,19 +253,6 @@ public void WriteSummary(string? dashboardUrl = null)
             {
                 AnsiConsole.MarkupLine(_finalStatusHeader!);
             }
-            if (!string.IsNullOrEmpty(dashboardUrl))
-            {
-                // Render dashboard URL as clickable link in interactive terminals, plain in non-interactive
-                var url = dashboardUrl;
-                if (!_hostEnvironment.SupportsInteractiveOutput || !_enableColor)
-                {
-                    AnsiConsole.MarkupLine($"Dashboard: {url.EscapeMarkup()}");
-                }
-                else
-                {
-                    AnsiConsole.MarkupLine($"Dashboard: [link={url}]{url}[/]");
-                }
-            }
             AnsiConsole.MarkupLine(line);
             AnsiConsole.WriteLine(); // Ensure final newline after deployment summary
         }

src/Aspire.Hosting/DistributedApplicationBuilder.cs

@@ -465,9 +465,11 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
         _innerBuilder.Services.AddSingleton(Pipeline);
 
         // Configure pipeline logging options
-        _innerBuilder.Services.Configure<PipelineLoggingOptions>(o =>
+        _innerBuilder.Services.Configure<PipelineLoggingOptions>(options =>
         {
-            o.MinimumLogLevel = _innerBuilder.Configuration["Pipeline:LogLevel"]?.ToLowerInvariant() switch
+            var config = _innerBuilder.Configuration;
+
+            options.MinimumLogLevel = config["Pipeline:LogLevel"]?.ToLowerInvariant() switch
             {
                 "trace" => LogLevel.Trace,
                 "debug" => LogLevel.Debug,
@@ -477,6 +479,8 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
                 "crit" or "critical" => LogLevel.Critical,
                 _ => LogLevel.Information
             };
+
+            options.IncludeExceptionDetails = config.GetBool("Pipeline:IncludeExceptionDetails") ?? false;
         });
 
         _innerBuilder.Services.AddSingleton<ILoggerProvider, PipelineLoggerProvider>();
@@ -576,17 +580,26 @@ private void ConfigurePipelineOptions(DistributedApplicationOptions options)
     {
         var switchMappings = new Dictionary<string, string>()
         {
+            // Legacy mappings for backward compatibility
             { "--operation", "AppHost:Operation" },
             { "--publisher", "Publishing:Publisher" },
+
+            // Pipeline options (valid for aspire do based commands)
+            { "--step", "Pipeline:Step" },
             { "--output-path", "Pipeline:OutputPath" },
             { "--log-level", "Pipeline:LogLevel" },
+            { "--include-exception-details", "Pipeline:IncludeExceptionDetails" },
+
+            // TODO: Rename this to something related to deployment state
             { "--clear-cache", "Pipeline:ClearCache" },
-            { "--step", "Pipeline:Step" },
+
+            // DCP Publisher options, we should only process these in run mode
             { "--dcp-cli-path", "DcpPublisher:CliPath" },
             { "--dcp-container-runtime", "DcpPublisher:ContainerRuntime" },
             { "--dcp-dependency-check-timeout", "DcpPublisher:DependencyCheckTimeout" },
             { "--dcp-dashboard-path", "DcpPublisher:DashboardPath" }
         };
+
         _innerBuilder.Configuration.AddCommandLine(options.Args ?? [], switchMappings);
 
         // Configure PipelineOptions from the Pipeline section

src/Aspire.Hosting/Pipelines/DistributedApplicationPipeline.cs

@@ -15,7 +15,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 
 namespace Aspire.Hosting.Pipelines;
@@ -538,19 +537,19 @@ async Task ExecuteStepWithDependencies(PipelineStep step)
                 try
                 {
                     var activityReporter = context.Services.GetRequiredService<IPipelineActivityReporter>();
-                    var publishingStep = await activityReporter.CreateStepAsync(step.Name, context.CancellationToken).ConfigureAwait(false);
+                    var reportingStep = await activityReporter.CreateStepAsync(step.Name, context.CancellationToken).ConfigureAwait(false);
 
-                    await using (publishingStep.ConfigureAwait(false))
+                    await using (reportingStep.ConfigureAwait(false))
                     {
                         var stepContext = new PipelineStepContext
                         {
                             PipelineContext = context,
-                            ReportingStep = publishingStep
+                            ReportingStep = reportingStep
                         };
 
                         try
                         {
-                            PipelineLoggerProvider.CurrentLogger = stepContext.Logger;
+                            PipelineLoggerProvider.CurrentStep = reportingStep;
 
                             await ExecuteStepAsync(step, stepContext).ConfigureAwait(false);
                         }
@@ -559,12 +558,12 @@ async Task ExecuteStepWithDependencies(PipelineStep step)
                             stepContext.Logger.LogError(ex, "Step '{StepName}' failed.", step.Name);
 
                             // Report the failure to the activity reporter before disposing
-                            await publishingStep.FailAsync(ex.Message, CancellationToken.None).ConfigureAwait(false);
+                            await reportingStep.FailAsync(ex.Message).ConfigureAwait(false);
                             throw;
                         }
                         finally
                         {
-                            PipelineLoggerProvider.CurrentLogger = NullLogger.Instance;
+                            PipelineLoggerProvider.CurrentStep = null;
                         }
                     }
 

src/Aspire.Hosting/Pipelines/IPipelineActivityReporter.cs

@@ -24,7 +24,6 @@ public interface IPipelineActivityReporter
     /// </summary>
     /// <param name="completionMessage">The completion message of the publishing process.</param>
     /// <param name="completionState">The completion state of the publishing process. When null, the state is automatically aggregated from all steps.</param>
-    /// <param name="isDeploy">Whether this is a deployment operation rather than a publishing operation.</param>
     /// <param name="cancellationToken">The cancellation token.</param>
-    Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, bool isDeploy = false, CancellationToken cancellationToken = default);
+    Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, CancellationToken cancellationToken = default);
 }

src/Aspire.Hosting/Pipelines/NullPipelineActivityReporter.cs

@@ -21,7 +21,7 @@ public Task<IReportingStep> CreateStepAsync(string title, CancellationToken canc
     }
 
     /// <inheritdoc />
-    public Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, bool isDeploy = false, CancellationToken cancellationToken = default)
+    public Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, CancellationToken cancellationToken = default)
     {
         return Task.CompletedTask;
     }

src/Aspire.Hosting/Pipelines/PipelineActivityReporter.cs

@@ -228,12 +228,11 @@ public async Task CompleteTaskAsync(ReportingTask task, CompletionState completi
         await ActivityItemUpdated.Writer.WriteAsync(state, cancellationToken).ConfigureAwait(false);
     }
 
-    public async Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, bool isDeploy = false, CancellationToken cancellationToken = default)
+    public async Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, CancellationToken cancellationToken = default)
     {
         // Use provided state or aggregate from all steps
         var finalState = completionState ?? CalculateOverallAggregatedState();
 
-        var operationName = "Pipeline";
         var state = new PublishingActivity
         {
             Type = PublishingActivityTypes.PublishComplete,
@@ -242,10 +241,10 @@ public async Task CompletePublishAsync(string? completionMessage = null, Complet
                 Id = PublishingActivityTypes.PublishComplete,
                 StatusText = completionMessage ?? finalState switch
                 {
-                    CompletionState.Completed => $"{operationName} completed successfully",
-                    CompletionState.CompletedWithWarning => $"{operationName} completed with warnings",
-                    CompletionState.CompletedWithError => $"{operationName} completed with errors",
-                    _ => $"{operationName} completed"
+                    CompletionState.Completed => "Pipeline completed successfully",
+                    CompletionState.CompletedWithWarning => "Pipeline completed with warnings",
+                    CompletionState.CompletedWithError => "Pipeline completed with errors",
+                    _ => "Pipeline completed"
                 },
                 CompletionState = ToBackchannelCompletionState(finalState)
             }