Skip to content

Remove SerialConsoleLogger #12336

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

Merged
YuliiaKovalova merged 4 commits into from
Aug 22, 2025
Merged

Remove SerialConsoleLogger #12336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c11a763
remove SerialConsoleLogger
YuliiaKovalova Aug 13, 2025
3e7c934
fix tests
YuliiaKovalova Aug 13, 2025
407d65e
update the comment
YuliiaKovalova Aug 13, 2025
e4f5d96
cleanup documentation
YuliiaKovalova Aug 19, 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
3 changes: 0 additions & 3 deletions documentation/wiki/CollectedTelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,8 @@ Expressed and collected via [LoggingConfigurationTelemetry type](https://github.
| >= 8.0.100 | Default choice on terminal logger enablement. |
| >= 8.0.100 | Source of default choice on terminal logger enablement. |
| >= 8.0.100 | Indication if Console logger was used. |
| >= 8.0.100 | Console logger type (serial, parallel). |
| >= 8.0.100 | Console logger verbosity. |
| >= 8.0.100 | Indication if File logger was used. |
| >= 8.0.100 | File logger type (serial, parallel). |
| >= 8.0.100 | Number of file loggers. |
| >= 8.0.100 | File logger verbosity. |
| >= 8.0.100 | Indication if Binary logger was used. |
| >= 8.0.100 | Indication if Binary logger used with default log name. |
Expand Down
12 changes: 3 additions & 9 deletions src/Build.UnitTests/BackEnd/LoggingConfigurationTelemetry_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ public void BuildTelemetryConstructedHasNoProperties()
telemetry.TerminalLoggerDefault.ShouldBeNull();
telemetry.TerminalLoggerDefaultSource.ShouldBeNull();
telemetry.ConsoleLogger.ShouldBe(false);
telemetry.ConsoleLoggerType.ShouldBeNull();
telemetry.ConsoleLoggerVerbosity.ShouldBeNull();
telemetry.FileLogger.ShouldBe(false);
telemetry.FileLoggerVerbosity.ShouldBeNull();
telemetry.FileLoggersCount.ShouldBe(0);
telemetry.FileLoggerVerbosity.ShouldBeNull();
telemetry.BinaryLogger.ShouldBe(false);
telemetry.BinaryLoggerUsedDefaultName.ShouldBe(false);

telemetry.GetProperties().Where(kv => kv.Value != bool.FalseString).ShouldBeEmpty();
telemetry.GetProperties()
.Where(kv => kv.Value != bool.FalseString)
.ShouldBeEmpty();
}

[Fact]
Expand All @@ -52,11 +52,8 @@ public void BuildTelemetryCreateProperProperties()
TerminalLoggerDefault = "auto",
TerminalLoggerDefaultSource = "sdk",
ConsoleLogger = true,
ConsoleLoggerType = "serial",
ConsoleLoggerVerbosity = "minimal",
FileLogger = true,
FileLoggerType = "serial",
FileLoggersCount = 2,
FileLoggerVerbosity = "normal",
BinaryLogger = true,
BinaryLoggerUsedDefaultName = true
Expand All @@ -69,11 +66,8 @@ public void BuildTelemetryCreateProperProperties()
properties["TerminalLoggerDefault"].ShouldBe("auto");
properties["TerminalLoggerDefaultSource"].ShouldBe("sdk");
properties["ConsoleLogger"].ShouldBe(bool.TrueString);
properties["ConsoleLoggerType"].ShouldBe("serial");
properties["ConsoleLoggerVerbosity"].ShouldBe("minimal");
properties["FileLogger"].ShouldBe(bool.TrueString);
properties["FileLoggerType"].ShouldBe("serial");
properties["FileLoggersCount"].ShouldBe("2");
properties["FileLoggerVerbosity"].ShouldBe("normal");
properties["BinaryLogger"].ShouldBe(bool.TrueString);
properties["BinaryLoggerUsedDefaultName"].ShouldBe(bool.TrueString);
Expand Down
17 changes: 2 additions & 15 deletions src/Build.UnitTests/BinaryLogger_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,20 +108,16 @@ public void TestBinaryLoggerRoundtrip(string projectText, BinlogRoundtripTestRep

var mockLogFromBuild = new MockLogger();

var serialFromBuildText = new StringBuilder();
var serialFromBuild = new SerialConsoleLogger(Framework.LoggerVerbosity.Diagnostic, t => serialFromBuildText.Append(t), colorSet: null, colorReset: null);
serialFromBuild.Parameters = "NOPERFORMANCESUMMARY";

var parallelFromBuildText = new StringBuilder();
var parallelFromBuild = new ParallelConsoleLogger(Framework.LoggerVerbosity.Diagnostic, t => parallelFromBuildText.Append(t), colorSet: null, colorReset: null);
parallelFromBuild.Parameters = "NOPERFORMANCESUMMARY";

// build and log into binary logger, mock logger, serial and parallel console loggers
// build and log into binary logger, mock logger and parallel console loggers
// no logging on evaluation
using (ProjectCollection collection = new())
{
Project project = ObjectModelHelpers.CreateInMemoryProject(collection, projectText);
project.Build(new ILogger[] { binaryLogger, mockLogFromBuild, serialFromBuild, parallelFromBuild }).ShouldBeTrue();
project.Build(new ILogger[] { binaryLogger, mockLogFromBuild, parallelFromBuild }).ShouldBeTrue();
}

string fileToReplay;
Expand Down Expand Up @@ -156,34 +152,25 @@ public void TestBinaryLoggerRoundtrip(string projectText, BinlogRoundtripTestRep

var mockLogFromPlayback = new MockLogger();

var serialFromPlaybackText = new StringBuilder();
var serialFromPlayback = new SerialConsoleLogger(Framework.LoggerVerbosity.Diagnostic, t => serialFromPlaybackText.Append(t), colorSet: null, colorReset: null);
serialFromPlayback.Parameters = "NOPERFORMANCESUMMARY";

var parallelFromPlaybackText = new StringBuilder();
var parallelFromPlayback = new ParallelConsoleLogger(Framework.LoggerVerbosity.Diagnostic, t => parallelFromPlaybackText.Append(t), colorSet: null, colorReset: null);
parallelFromPlayback.Parameters = "NOPERFORMANCESUMMARY";

var binaryLogReader = new BinaryLogReplayEventSource();
mockLogFromPlayback.Initialize(binaryLogReader);
serialFromPlayback.Initialize(binaryLogReader);
parallelFromPlayback.Initialize(binaryLogReader);

// read the binary log and replay into mockLogger2
binaryLogReader.Replay(fileToReplay);
mockLogFromPlayback.Shutdown();
serialFromPlayback.Shutdown();
parallelFromPlayback.Shutdown();

// the binlog will have more information than recorded by the text log
mockLogFromPlayback.FullLog.ShouldContainWithoutWhitespace(mockLogFromBuild.FullLog);

var serialExpected = serialFromBuildText.ToString();
var serialActual = serialFromPlaybackText.ToString();
var parallelExpected = parallelFromBuildText.ToString();
var parallelActual = parallelFromPlaybackText.ToString();

serialActual.ShouldContainWithoutWhitespace(serialExpected);
parallelActual.ShouldContainWithoutWhitespace(parallelExpected);
}

Expand Down
Loading