repository·master·Indexed 43 days ago
https://github.com/suchiman/seriloganalyzerA Roslyn-based static analysis tool for C# projects using the Serilog logging library. It identifies common pitfalls such as incorrect exception handling, malformed message templates, property binding issues, and performance problems related to non-constant templates. Includes specific analyzers Serilog001 through Serilog008 and provides CodeFixes for several rules.
Building the project produces an analyzer .dll. You can package this in two ways depending on your deployment needs:
.nupkg): Adds the analyzer as a project-local analyzer that participates in builds. This is the standard way to distribute analyzers for use in CI/CD and local development..vsix): Applies the analyzer to all projects within the IDE. This is useful for IDE-only enforcement.To verify a .nupkg file locally, follow these steps:
.nupkg file into your local feed folder.SerilogAnalyzer is a Roslyn-based analyzer that checks for common mistakes and usage problems when using the Serilog logging library. You can install it using one of the following methods:
SerilogAnalyzer NuGet package to your project.dotnet add package SerilogAnalyzerYou can configure the project to automatically copy the .nupkg file to your local NuGet feed folder upon every build by modifying the project file:
<AfterBuild> target in the XML.<Exec> task, update the Command attribute. Change the path following the -OutputDirectory flag to point to your local NuGet feed folder.<!-- Example of the target to modify in the .csproj file -->
<Target Name="AfterBuild">
<Exec Command="... -OutputDirectory C:\Your\Local\NuGet\Feed\Path" />
</Target>LoggerConfiguration calls to generate configuration suitable for use with serilog-settings-appsettings or serilog-settings-configuration (e.g., appSettings.json).The Serilog003 analysis ensures coherence between message template tokens and the supplied arguments. Every property named in the message template must correspond to exactly one argument.
Incorrect usage:
Log.Information("Saving {File} to {Directory}", file);Correct usage:
Log.Information("Saving {File} to {Directory}", file, directory);Log.Information("Saving {File} to {Directory}", file, directory);The Serilog007 analysis checks that anonymous objects passed to the logger use the destructuring operator (@). Without this, the object is logged as a string rather than its properties.
Incorrect usage:
Log.Information("Saving {File} to {Directory}", new { Name = name, Size = size }, directory); Correct usage:
Log.Information("Saving {@File} to {Directory}", new { Name = name, Size = size }, directory); A CodeFix is available to apply the destructuring hint (@).
Log.Information("Saving {@File} to {Directory}", new { Name = name, Size = size }, directory);The Serilog001 analysis checks that exceptions are passed to the exception argument rather than being treated as a normal property. Serilog provides special handling for exceptions when they are passed as the first argument of a log method call.
Incorrect usage:
catch (Exception ex)
{
Log.Error("Could not save {File}: {Error}", file, ex);
}Correct usage:
catch (Exception ex)
{
Log.Error(ex, "Could not save {File}", file);
}A CodeFix is available to correct this usage.
Log.Error(ex, "Could not save {File}", file);The Serilog008 analysis ensures that contextual loggers are constructed using the correct type for the class they are in.
Incorrect usage:
class A
{
private static readonly ILogger Logger = Logger.ForContext<B>();
}
class B {}Correct usage:
class A
{
private static readonly ILogger Logger = Logger.ForContext<A>();
}
class B {}A CodeFix is available to update the type in the ForContext<T> call.
private static readonly ILogger Logger = Logger.ForContext<A>();The Serilog005 analysis checks that all property names within a single message template are unique. If names are duplicated, Serilog may only record one of them.
Incorrect usage:
Log.Information("Saving {Path} to {Path}", file, directory); Correct usage:
Log.Information("Saving {File} to {Directory}", file, directory); Log.Information("Saving {File} to {Directory}", file, directory);The Serilog006 analysis checks that all property names in a message template use PascalCase.
Incorrect usage:
Log.Information("Saving {file} to {directory}", file, directory); Correct usage:
Log.Information("Saving {File} to {Directory}", file, directory); A CodeFix is available to automatically apply Pascal casing to property names.
Log.Information("Saving {File} to {Directory}", file, directory);