Cognitic.Tools.Logging.InMemory 1.0.0

Cognitic.Tools.Logging.InMemory

This is the description of what the code block changes: Populate README.md with a project overview, features, quick start and usage instructions.

Project overview

Cognitic.Tools.Logging.InMemory is a small utility library that provides an in-memory logger implementation for Microsoft.Extensions.Logging. It is intended primarily for unit tests and diagnostics where capturing and asserting log output is useful.

Key features

• Records log messages into a shared in-memory collection (IList<LogInfo>).
• Simple ILoggerProvider and ILogger implementations suitable for tests.
• Easy to register with ILoggingBuilder using the AddInMemory() extension.
• Target: .NET8 / C#12.

Public surface

• LogInfo � a record that represents a captured log entry. Important properties:

• LogLevel (severity)

• Name (logger category)

• EventId (event identifier)

• Exception (optional)

• Message (formatted message)

• InMemoryLoggerProvider � creates and caches InMemoryLogger instances.

• InMemoryLogger � writes log entries into the shared IList<LogInfo>.

• InMemoryLoggerExtensions.AddInMemory() � registers the provider and the shared IList<LogInfo> in the DI container.

Quick start

1. Register the in-memory logger in your test's service collection:

IServiceCollection services = new ServiceCollection();
services.AddLogging(builder => builder.AddInMemory());

IServiceProvider provider = services.BuildServiceProvider();
var logger = provider.GetRequiredService<ILogger<Program>>();
var logs = provider.GetRequiredService<IList<LogInfo>>();

logger.LogInformation("Hello from tests");
// assert on `logs`

2. Use logs in assertions to verify message text, level, event id or exception.

Notes and usage tips

• The in-memory log collection is registered as a singleton IList<LogInfo>. Multiple logger instances share the same collection, which makes it convenient to assert all recorded messages across categories.
• The provider and logger are intentionally simple and do not implement advanced features such as structured scope storage or configurable filtering beyond LogLevel.None.

Building and testing

• This solution targets .NET8. Build and run tests using the .NET CLI:

dotnet build
dotnet test

License

MIT

Contact

Use the repository issues to report bugs or request features.