Skip to content

Add telemetry logger support for API-based MSBuild usage #51068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: release/10.0.1xx
Choose a base branch
from
Open

Add telemetry logger support for API-based MSBuild usage #51068

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a486b0f
Add telemetry logger support for API-based MSBuild usage
Copilot Sep 30, 2025
e7615ba
Add tests for ProjectInstanceExtensions telemetry logger creation
Copilot Sep 30, 2025
9ad23cf
Fix telemetry logger to use distributed logging pattern with central …
Copilot Sep 30, 2025
145a66f
Fix ForwardingLoggerRecord to use central logger instance with forwar…
Copilot Sep 30, 2025
c73c4cc
Share telemetry central logger instance between ProjectCollection and…
Copilot Sep 30, 2025
e3dccd6
Add integration test for telemetry logger receiving events from API-b…
Copilot Sep 30, 2025
fb7514c
Add telemetry logger support to VirtualProjectBuildingCommand
Copilot Oct 1, 2025
d62f17c
Add telemetry logger support to PackageAddCommand for project evaluation
Copilot Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add tests for ProjectInstanceExtensions telemetry logger creation 
Co-authored-by: baronfel <[email protected]>
  • Loading branch information
@Copilot @baronfel
Copilot and baronfel committed Oct 3, 2025
commit e7615ba26ecbf29d868398b3a7da370013b72be2
81 changes: 81 additions & 0 deletions test/dotnet.Tests/CommandTests/MSBuild/GivenProjectInstanceExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable disable

using Microsoft.Build.Execution;
using Microsoft.DotNet.Cli.Extensions;
using Microsoft.DotNet.Cli.Telemetry;

namespace Microsoft.DotNet.Cli.MSBuild.Tests;

public class GivenProjectInstanceExtensions
{
[Fact]
public void CreateTelemetryLoggers_WhenTelemetryDisabled_ReturnsNull()
{
// Ensure telemetry is disabled
Telemetry.Telemetry.CurrentSessionId = null;

var loggers = ProjectInstanceExtensions.CreateTelemetryLoggers();

loggers.Should().BeNull();
}

[Fact]
public void CreateTelemetryLoggers_WhenTelemetryEnabled_ReturnsLoggers()
{
// Enable telemetry with a session ID
var originalSessionId = Telemetry.Telemetry.CurrentSessionId;
try
{
Telemetry.Telemetry.CurrentSessionId = Guid.NewGuid().ToString();

var loggers = ProjectInstanceExtensions.CreateTelemetryLoggers();

loggers.Should().NotBeNull();
loggers.Should().HaveCount(1);
loggers[0].Should().BeOfType<Commands.MSBuild.MSBuildLogger>();
}
finally
{
// Restore original session ID
Telemetry.Telemetry.CurrentSessionId = originalSessionId;
}
}

[Fact]
public void BuildWithTelemetry_WhenTelemetryDisabled_CallsBuildWithoutTelemetryLogger()
{
// This is a basic smoke test to ensure the extension method doesn't throw
// We can't easily test the actual build without setting up a full project

// Ensure telemetry is disabled
Telemetry.Telemetry.CurrentSessionId = null;

// CreateTelemetryLoggers should return null when telemetry is disabled
var loggers = ProjectInstanceExtensions.CreateTelemetryLoggers();
loggers.Should().BeNull();
}

[Fact]
public void BuildWithTelemetry_WhenTelemetryEnabled_CreatesTelemetryLogger()
{
// Enable telemetry with a session ID
var originalSessionId = Telemetry.Telemetry.CurrentSessionId;
try
{
Telemetry.Telemetry.CurrentSessionId = Guid.NewGuid().ToString();

// CreateTelemetryLoggers should return logger when telemetry is enabled
var loggers = ProjectInstanceExtensions.CreateTelemetryLoggers();
loggers.Should().NotBeNull();
loggers.Should().HaveCount(1);
}
finally
{
// Restore original session ID
Telemetry.Telemetry.CurrentSessionId = originalSessionId;
}
}
}