Add ILogger to BicepCliCompiler with ContainerRuntimeBase-style logging by Copilot · Pull Request #12908 · microsoft/aspire

Copilot · 2025-11-11T20:33:02Z

Description

Adds structured logging to BicepCliCompiler following the established pattern in ContainerRuntimeBase.cs. Provides observability for Bicep compilation operations with debug logs for command execution and stdout/stderr, error logs with exit codes, and info logs for successful compilations.

Changes:

Added ILogger<BicepCliCompiler> constructor dependency with null validation
Added debug logging: command execution and stdout/stderr via ProcessSpec callbacks (logged line-by-line as received)
Added error logging with exit codes on compilation failure
Added info logging on successful compilation
Changed ExecuteCommand return type from bool to int for exit code visibility

Example log output:

dbug: BicepCliCompiler[0]
      Running /usr/local/bin/bicep with arguments: build "template.bicep" --stdout
dbug: BicepCliCompiler[0]
      /usr/local/bin/bicep (stdout): { "$schema": "..." }
dbug: BicepCliCompiler[0]
      /usr/local/bin/bicep (stderr): [any error messages]
info: BicepCliCompiler[0]
      Bicep compilation for template.bicep succeeded.

On compilation failure:

erro: BicepCliCompiler[0]
      Bicep compilation for template.bicep failed with exit code 1.

Fixes #12345

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue (consider using one of the following templates):
- No

Original prompt

BicepCompiler should take an ILogger and CompileBicepToArmAsync should mimic the logging style of https://github.com/dotnet/aspire/blob/25b785a79a90a03da138ec0a6e62d5ba1439b2b3/src/Aspire.Hosting/Publishing/ContainerRuntimeBase.cs.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

… logging Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

github-actions · 2025-11-12T05:32:34Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12908

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12908"

davidfowl · 2025-11-12T05:37:37Z

/backport to release/13.0

github-actions · 2025-11-12T05:37:47Z

Started backporting to release/13.0: https://github.com/dotnet/aspire/actions/runs/19287579631

Copilot

Pull Request Overview

This PR adds structured logging to BicepCliCompiler following the established logging pattern from ContainerRuntimeBase.cs. The changes provide observability for Bicep compilation operations through debug, info, and error logs, with the main implementation change being the addition of an ILogger<BicepCliCompiler> dependency and logging at key points during compilation.

Key changes:

Added ILogger dependency injection with null validation
Enhanced observability with debug/info/error logging throughout compilation lifecycle
Changed ExecuteCommand return type from bool to int to expose exit codes for better error reporting

Copilot · 2025-11-12T05:42:12Z

        }

        var armTemplateContents = new StringBuilder();
+        var errorOutput = new StringBuilder();


The errorOutput StringBuilder is declared and populated but never used. While capturing stderr is good practice for potential future diagnostics, consider either logging the accumulated error output when compilation fails (to provide more context in the error log) or removing it if not needed.

@copilot apply changes based on this feedback

Log the output in debug.

Applied. The accumulated error output is now logged at debug level when compilation fails (commit 197f5f7). This provides additional diagnostic context while keeping the main error log focused on the exit code and file path.

Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

davidfowl · 2025-11-12T05:52:27Z

+            var errorText = errorOutput.ToString();
+            if (!string.IsNullOrWhiteSpace(errorText))
+            {
+                _logger.LogDebug("Error output: {ErrorOutput}", errorText);
+            }


@copilot it occurs to me that we don't need this because we log the stderr already. Remove errorOutput fully.

Removed in commit 1349f0c. The errorOutput StringBuilder was redundant since stderr is already being logged line-by-line in the OnErrorData callback.

…gged Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

davidfowl · 2025-11-13T06:17:47Z

/backport to release/13.0

github-actions · 2025-11-13T06:17:54Z

Started backporting to release/13.0: https://github.com/dotnet/aspire/actions/runs/19322463663

davidfowl · 2025-11-13T08:57:12Z

OK this should be debug:

[INF] Bicep compilation for
/var/folders/yx/2sfj5rw95xxb_4mg1vlnlpsh0000gn/T/aspire4zPb4z/templateapp-api-roles-postgres-kv.module.bicep succeeded.
00:56:14 (provision-postgres) i [INF] Bicep compilation for /var/folders/yx/2sfj5rw95xxb_4mg1vlnlpsh0000gn/T/aspireQwal5g/postgres.module.bicep succeeded.

Initial plan

635faad

Copilot AI assigned Copilot and davidfowl Nov 11, 2025

Copilot started work on behalf of davidfowl November 11, 2025 20:33 View session

Add ILogger to BicepCompiler and implement ContainerRuntimeBase-style…

abeb3c7

… logging Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add ILogger to BicepCompiler and update logging style~~ Add ILogger to BicepCliCompiler with ContainerRuntimeBase-style logging Nov 11, 2025

Copilot AI requested a review from davidfowl November 11, 2025 20:54

Copilot finished work on behalf of davidfowl November 11, 2025 20:54

davidfowl marked this pull request as ready for review November 12, 2025 05:32

davidfowl requested review from captainsafia and eerhardt as code owners November 12, 2025 05:32

Copilot AI review requested due to automatic review settings November 12, 2025 05:32

Copilot started reviewing on behalf of davidfowl November 12, 2025 05:32 View session

Copilot finished reviewing on behalf of davidfowl November 12, 2025 05:34

github-actions Bot mentioned this pull request Nov 12, 2025

[release/13.0] Add ILogger to BicepCliCompiler with ContainerRuntimeBase-style logging #12922

Closed

Copilot AI reviewed Nov 12, 2025

View reviewed changes

Copilot started work on behalf of davidfowl November 12, 2025 05:46 View session

Log accumulated error output in debug when compilation fails

197f5f7

Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

davidfowl reviewed Nov 12, 2025

View reviewed changes

Copilot AI requested a review from davidfowl November 12, 2025 05:53

Copilot finished work on behalf of davidfowl November 12, 2025 05:53

Copilot started work on behalf of davidfowl November 12, 2025 05:54 View session

Remove redundant errorOutput StringBuilder since stderr is already lo…

1349f0c

…gged Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot finished work on behalf of davidfowl November 12, 2025 06:01

mitchdenny approved these changes Nov 12, 2025

View reviewed changes

eerhardt approved these changes Nov 12, 2025

View reviewed changes

davidfowl merged commit 71ea2e1 into main Nov 13, 2025
584 of 591 checks passed

davidfowl deleted the copilot/add-logger-to-bicep-compiler branch November 13, 2025 06:17

dotnet-policy-service Bot added this to the 13.1 milestone Nov 13, 2025

github-actions Bot locked and limited conversation to collaborators Dec 13, 2025

Conversation

Copilot AI commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

github-actions Bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Nov 12, 2025

Uh oh!

github-actions Bot commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davidfowl Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davidfowl commented Nov 13, 2025

Uh oh!

github-actions Bot commented Nov 13, 2025

Uh oh!

davidfowl commented Nov 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Nov 11, 2025 •

edited

Loading

github-actions Bot commented Nov 12, 2025 •

edited

Loading