Stravaig.Extensions.Logging.Diagnostics 3.0.1

dotnet add package Stravaig.Extensions.Logging.Diagnostics --version 3.0.1                
NuGet\Install-Package Stravaig.Extensions.Logging.Diagnostics -Version 3.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stravaig.Extensions.Logging.Diagnostics" Version="3.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Stravaig.Extensions.Logging.Diagnostics --version 3.0.1                
#r "nuget: Stravaig.Extensions.Logging.Diagnostics, 3.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Stravaig.Extensions.Logging.Diagnostics as a Cake Addin
#addin nuget:?package=Stravaig.Extensions.Logging.Diagnostics&version=3.0.1

// Install Stravaig.Extensions.Logging.Diagnostics as a Cake Tool
#tool nuget:?package=Stravaig.Extensions.Logging.Diagnostics&version=3.0.1                

About

Stravaig Log Capture is a way to capture the logs in a test and examine them to ensure they are being generated correctly.

Version & Framework support

  • v1.x: Supports .NET Core 3.1 & .NET 5
  • v2.x: Supports .NET 6.0, 7.0 & 8.0
  • v3.x: Supports .NET 6.0, 8.0 & 9.0

Why do I want to test my logs?

Checking logs in test can be beneficial for a number of reasons. For example, in a background service the log is effectively its user interface (the user being the developer or system admin whose job it is to monitor the correct running of background services). By verifying the logs in tests, you can ensure that appropriate information is being delivered.

Logging may also exist to output audit trails for the application, and you need to check in tests that it is being produced correctly.

How to use

For simple tests you can pass the logger into the class under test like this:

[Test]
public void EnsureSomeFunctionalityWorks()
{
    // Arrange
    var logger = new TestCaptureLogger<ServiceClass>();
    var service = new ServiceClass(logger);
    
    // Act
    service.DoSomething();
    
    // Assert
    var logs = logger.GetLogs();
    logs.Count.ShouldBe(1);
    logs[0].OriginalMessage.ShouldBe("Did something.");
}

See also

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Stravaig.Extensions.Logging.Diagnostics:

Package Downloads
Stravaig.Extensions.Logging.Diagnostics.XUnit

XUnit extensions for Stravaig Logging Capture for Tests. Use version 2.x for .NET 6.0 onwards. Use version 3.x for .NET 6.0, 8.0 & 9.0 onwards.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.1 1,343 12/1/2024
3.0.0-preview.466 46 11/23/2024
3.0.0-preview.463 55 11/16/2024
3.0.0-preview.455 49 11/3/2024
2.2.1 10,931 2/27/2024
2.2.0 2,416 11/15/2023
2.2.0-preview.383 84 11/15/2023
2.1.0 4,134 7/31/2023
2.1.0-preview.356 105 7/30/2023
2.0.1 1,064 6/13/2023
2.0.0 779 2/11/2023
2.0.0-preview.305 104 12/11/2022
1.4.1 1,092 12/6/2022
1.4.0 711 11/13/2022
1.3.3 1,011 9/14/2022
1.3.2 1,098 8/9/2022
1.3.2-preview.267 119 8/9/2022
1.3.1 482 8/6/2022
1.3.1-preview.263 119 8/6/2022
1.3.0 1,422 5/23/2022
1.2.3 745 5/11/2022
1.2.2 971 4/12/2022
1.2.1 922 3/9/2022
1.2.0 1,252 2/6/2022
1.2.0-preview.227 157 12/20/2021
1.2.0-preview.212 252 11/13/2021
1.1.4 1,242 11/13/2021
1.1.3 802 10/12/2021
1.1.2 669 9/14/2021
1.1.1 680 8/11/2021
1.1.0 607 7/30/2021
1.0.1 745 7/14/2021
1.0.0 905 6/19/2021
0.4.4-preview.160 220 6/19/2021
0.4.3 489 6/9/2021
0.4.2 731 5/15/2021
0.4.1 940 4/12/2021
0.4.0 777 3/20/2021
0.4.0-preview.123 229 3/19/2021
0.3.2 972 2/11/2021
0.3.1 1,417 1/13/2021
0.3.0 884 12/14/2020
0.2.2 698 11/22/2020
0.2.1 639 10/25/2020
0.2.0 508 10/20/2020
0.1.0 684 10/8/2020
0.0.3-preview.37 268 10/7/2020