stbychkov.AutoLoggerMessage 1.0.5

AutoLoggerMessage

Welcome to AutoLoggerMessage, a source generator that automatically creates LoggerMessage methods, enabling high-performance logging..

Demo

Getting started

Just follow these two simple steps:

1. Install the Package from NuGet

dotnet add package stbychkov.AutoLoggerMessage

2. Enable interceptors

Interceptors can be enabled either for a specific project or globally by defining them in the Directory.Build.props file

<PropertyGroup>
    <InterceptorsPreviewNamespaces>$(InterceptorsPreviewNamespaces);Microsoft.Extensions.Logging.AutoLoggerMessage</InterceptorsPreviewNamespaces>
</PropertyGroup>

Configuration

The source generator has a few configurable properties that control its behavior. These properties are passed as build configurations and modify the generated code in different ways..

To configure one of these properties in your project, add the following line to the .editorconfig file.

build_property.AutoLoggerMessageGenerator_GenerateInterceptorAttribute = true

or in your project configuration file (specific or global)

<PropertyGroup>
    ...
    <AutoLoggerMessageGenerator_GenerateInterceptorAttribute>true</AutoLoggerMessageGenerator_GenerateInterceptorAttribute>
</PropertyGroup>

Benchmarks

There are six main configurations::

1. Logger from Microsoft.Extensions.Logging.Abstractions package (default)
2. Source generator from Microsoft.Extensions.Logging.Abstractions package (default-gen)
3. Logger from Microsoft.Extensions.Telemetry.Abstractions package (telemetry)
4. Source generator from Microsoft.Extensions.Telemetry.Abstractions package (telemetry-gen)
5. Source generator from AutoLoggerMessage package (auto-gen)
6. Source generator from AutoLoggerMessage package with Microsoft.Extensions.Logging.Abstractions installed ( auto-telemetry-sgen)

<details> <summary>Logging without any parameters</summary>

For logging without parameters, the difference is minimal

</details>

<details> <summary>Logging up to 6 parameters</summary>

When parameters are provided, source generators outperform the other configurations in terms of execution time and memory usage. The AutoLoggerMessage source generator adds minimal overhead.

</details>

<details> <summary>Logging with 7+ parameters</summary>

Due to a limitation, we fall back to the original implementation. The results are similar, but default-gen configuration still uses an optimized version as it packs these parameters into a structure. Something to address in the next release, as the usage of six or more parameters usually is quite low.

</details>

<details> <summary>Logging complex objects</summary>

For logging complex objects with a tree-like structure, we observe that source generators do not allocate memory and yield faster results.

</details>

<details> <summary>Logging complex objects with [LogProperties] enabled</summary>

Results are about the same.

</details>

Known Limitations

• It supports only static EventId parameter. If you pass the explicit EventId parameter, which basically no one does as far as I can tell, it generates a new EventId and the existing one will be passed to the formatter state, but it won't be logged. This limitation comes from the original LoggerMessage generator as they don't support the explicit parameter ~~ yet~~.
• Log.Define supports only 6 message parameters (src) so if you pass more than that, the default Logger.Log(*, params object[] args) will be executed.
• As this solution is based on interceptors, only .NET 8+ is supported

Motivation

Source-generated logging is increasingly recognized as a modern and efficient approach. But let’s be real, when you’ve got a mid-sized project, migrating to the new logging approach is not exactly a simple task. And even when starting a new project, marking every class as partial or depending on an external partial class for logging messages can feel disconnected from the code where they are actually used.

That’s where this library comes in. It’s like a magic wand that automatically migrates all your old logging calls to the shiny new source-generated approach with zero changes to your code. This library handles most of the heavy lifting for you, so you can spend your time doing more important things!

I hope this is a temporary solution — maybe one day, something similar will be added out of the box.

How It Works

This source generator searches for all logger.Log* methods in your code and, based on their parameters, automatically creates partial methods for LoggerMessage. It also generates a set of interceptors to forward the logging calls to the newly generated LoggerMessage methods.

For more details, see the How It Works documentation

Questions?

I bet you have some questions about why things are set up the way they are. Refer to the ADR files for detailed explanations of the design decisions behind this package.