feat: Switch to Serilog #441

melotic · 2023-02-21T18:24:38Z

This PR switches from our slow custom-built logging service to Serilog with Microsoft.Extensions.Loggging support. Each class gets their own injected logger unique to their type.

We also create a LoggerProviderCollection and will allow our dependents to dynamically attach other sinks such as ApplicationInsights.

New format:

Closes #436

Compiles, but running & tests are still broken.

This allows to optionally write events through other dynamically-added MEL `ILoggerProviders`.

…-serilog # Conflicts: # src/Microsoft.ComponentDetection.Detectors/cocoapods/PodComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/go/GoComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/ivy/IvyDetector.cs # src/Microsoft.ComponentDetection.Detectors/maven/MavenCommandService.cs # src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/nuget/NuGetComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/pip/PythonResolver.cs # src/Microsoft.ComponentDetection.Detectors/ruby/RubyComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/rust/RustCrateDetector.cs # src/Microsoft.ComponentDetection.Detectors/vcpkg/VcpkgComponentDetector.cs # src/Microsoft.ComponentDetection.Detectors/yarn/Parsers/YarnLockParser.cs # src/Microsoft.ComponentDetection.Detectors/yarn/YarnLockComponentDetector.cs # src/Microsoft.ComponentDetection.Orchestrator/Services/DetectorProcessingService.cs # src/Microsoft.ComponentDetection/Program.cs # test/Microsoft.ComponentDetection.Detectors.Tests/YarnLockDetectorTests.cs # test/Microsoft.ComponentDetection.Detectors.Tests/YarnParserTests.cs

github-actions · 2023-02-21T18:26:51Z

👋 Hi! It looks like you modified some files in the Detectors folder.
You may need to bump the detector versions if any of the following scenarios apply:

The detector detects more or fewer components than before
The detector generates different parent/child graph relationships than before
The detector generates different devDependencies values than before

If none of the above scenarios apply, feel free to ignore this comment 🙂

# Conflicts: # src/Microsoft.ComponentDetection.Common/Logger.cs

src/Microsoft.ComponentDetection.Common/ComponentStreamEnumerable.cs

JamieMagee · 2023-02-21T21:51:26Z

I think only Microsoft.ComponentDetection should depend on Microsoft.Extensions.Logging, but all other packages should depend on Microsoft.Extensions.Logging.Abstractions.

src/Microsoft.ComponentDetection.Common/DependencyGraph/ComponentRecorder.cs

src/Microsoft.ComponentDetection.Contracts/Microsoft.ComponentDetection.Contracts.csproj

...osoft.ComponentDetection.Detectors/nuget/NuGetProjectModelProjectCentricComponentDetector.cs

src/Microsoft.ComponentDetection.Detectors/pip/IPyPiClient.cs

src/Microsoft.ComponentDetection.Orchestrator/Orchestrator.cs

test/Microsoft.ComponentDetection.Common.Tests/ComponentStreamEnumerableTests.cs

test/Microsoft.ComponentDetection.Detectors.Tests/IvyDetectorTests.cs

test/Microsoft.ComponentDetection.Detectors.Tests/LinuxContainerDetectorTests.cs

JamieMagee · 2023-02-21T22:17:04Z

Can you also remove ServiceBase abstract class as part of this?

src/Microsoft.ComponentDetection.Common/ComponentStreamEnumerable.cs

src/Microsoft.ComponentDetection.Common/PathUtilityService.cs

src/Microsoft.ComponentDetection.Detectors/cocoapods/PodComponentDetector.cs

src/Microsoft.ComponentDetection.Detectors/ivy/IvyDetector.cs

src/Microsoft.ComponentDetection.Detectors/pip/PipComponentDetector.cs

src/Microsoft.ComponentDetection.Detectors/vcpkg/VcpkgComponentDetector.cs

src/Microsoft.ComponentDetection.Common/Microsoft.ComponentDetection.Common.csproj

src/Microsoft.ComponentDetection.Orchestrator/Microsoft.ComponentDetection.Orchestrator.csproj

# Conflicts: # Directory.Packages.props

…on tests

src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetector.cs

src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetectorWithRoots.cs

src/Microsoft.ComponentDetection.Detectors/pip/IPyPiClient.cs

src/Microsoft.ComponentDetection.Detectors/pnpm/PnpmComponentDetector.cs

src/Microsoft.ComponentDetection.Detectors/ruby/RubyComponentDetector.cs

src/Microsoft.ComponentDetection/Program.cs

...crosoft.ComponentDetection.Orchestrator.Tests/Services/DetectorListingCommandServiceTests.cs

JamieMagee

Good to merge once all tests pass

# Conflicts: # Directory.Packages.props

src/Microsoft.ComponentDetection.Orchestrator/Extensions/ServiceCollectionExtensions.cs

should fix the verification tests!

The previous logger added a space after `Detection time: xx.yyyyyy seconds. `. The new logger does not have a trailing space.

melotic added 6 commits February 17, 2023 15:00

refactor: initial switch to Serilog

073917c

Compiles, but running & tests are still broken.

fix: create logger with a LoggerProviderCollection

8636519

This allows to optionally write events through other dynamically-added MEL `ILoggerProviders`.

fix: bad merge

c04ab19

fix: update unit tests

de07264

fix: ILogger injection for PythonResolver.cs

867ad76

melotic requested a review from a team as a code owner February 21, 2023 18:24

melotic requested a review from FernandoRojo February 21, 2023 18:24

melotic added 2 commits February 21, 2023 11:01

fix: Add Microsoft.Extensions.Logging package to Verification Tests

f62d6fc

Merge branch 'main' into justinperez/switch-to-serilog

c975856

# Conflicts: # src/Microsoft.ComponentDetection.Common/Logger.cs