Logging aspect support for MVVM
Get Started
$ dotnet add package OutWit.Common.LoggingReadme
Install
Install-Package OutWit.Common.Logging
or
> dotnet add package OutWit.Common.Logging
Streamlining Logging with the Log Aspect
Maintaining logs is critical for debugging and supporting complex applications. Manually adding logging calls everywhere can be tedious and error-prone. The OutWit.Common.Logging package simplifies this process with three powerful aspects: Log, NoLog, and Measure. The source code is available here.
Setting Up the Logger
Before using the logging aspects, initialize the logger. The current implementation is based on Serilog:
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Is(LogEventLevel.Information)
.Enrich.WithExceptionDetails()
.WriteTo.File(@"D:\Log\Log.txt",
rollingInterval: RollingInterval.Day,
rollOnFileSizeLimit: true,
fileSizeLimitBytes: 524288)
.CreateLogger();
The Log Aspect
The Log aspect can be applied to individual methods:
public class Model
{
[Log]
public void DoSomething1()
{
}
public void DoSomething2()
{
}
}
Or to an entire class:
[Log]
public class Model
{
public void DoSomething1()
{
}
public void DoSomething2()
{
}
}
When applied to a class, it automatically applies to all methods within the class.
What Does the Log Aspect Do?
- Exception Handling: Wraps method execution in a try-catch block and logs exceptions with their details.
- Method Execution Logging: Logs method calls (excluding property getters/setters) if the logger’s MinimumLevel is Information or lower.
- Detailed Property Access Logging: If the logger’s MinimumLevel is Verbose, it also logs property access.
This flexibility allows you to control log verbosity by adjusting the logger's configuration.
The NoLog Aspect
If the Log aspect is applied to a class, but you want to exclude specific methods from logging, you can use the NoLog aspect:
[Log]
public class Model
{
public void DoSomething1()
{
}
[NoLog]
public void DoSomething2()
{
}
}
The Measure Aspect
To measure the execution time of a method, apply the Measure aspect. This will log the duration in milliseconds:
public class Model
{
public void DoSomething1()
{
}
[Measure]
public void DoSomething2()
{
}
}
When DoSomething2 is called, the log will include the method’s execution time.
Key Benefits
- Automates logging for methods and properties.
- Simplifies exception handling by centralizing logging.
- Provides flexible control over log verbosity.
- Enables easy performance measurement.
For more details, check out the article.
License
Licensed under the Apache License, Version 2.0. See LICENSE.
Attribution (optional)
If you use OutWit.Common.Logging in a product, a mention is appreciated (but not required), for example: "Powered by OutWit.Common.Logging (https://ratner.io/)".
Trademark / Project name
"OutWit" and the OutWit logo are used to identify the official project by Dmitry Ratner.
You may:
- refer to the project name in a factual way (e.g., "built with OutWit.Common.Logging");
- use the name to indicate compatibility (e.g., "OutWit.Common.Logging-compatible").
You may not:
- use "OutWit.Common.Logging" as the name of a fork or a derived product in a way that implies it is the official project;
- use the OutWit.Common.Logging logo to promote forks or derived products without permission.