feat: add error criticality level

Author: mt89vein

.editorconfig

@@ -489,4 +489,7 @@ dotnet_diagnostic.CA1711.severity = none
 dotnet_diagnostic.IDE0290.severity = none
 
 # prefer new C# 12 collection initialzier
-dotnet_diagnostic.IDE0028.severity = none
+dotnet_diagnostic.IDE0028.severity = none
+
+# unused public parameter
+dotnet_diagnostic.IDE0060.severity = none

Directory.Build.props

@@ -18,12 +18,4 @@
     <EnablePackageValidation>true</EnablePackageValidation>
   </PropertyGroup>
 
-  <PropertyGroup Condition="$(IsPackable) == 'true'">
-    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <IncludeSymbols>true</IncludeSymbols>
-    <SymbolPackageFormat>symbols.nupkg</SymbolPackageFormat>
-    <DocumentationFile>bin\$(Configuration)\$(MSBuildProjectName).xml</DocumentationFile>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-  </PropertyGroup>
-
 </Project>

Sstv.DomainExceptions.Extensions.DependencyInjection/CHANGELOG.md

@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.0] - 2024-12-06
+
+### Changed
+
+- error_codes_total metric now have level label from error code
+
+BREAKING CHANGES:
+- ErrorCodesMeter now accept ErrorDescription and instance of error, instead of DomainException. This helps to use not only exceptions, but also Result pattern.
+
 ## [2.0.0] - 2024-02-11
 
 - Source gen release

Sstv.DomainExceptions.Extensions.DependencyInjection/ErrorCodesDescriptionFromConfigurationSource.cs

@@ -1,12 +1,10 @@
 using Microsoft.Extensions.Configuration;
-using System.Diagnostics.CodeAnalysis;
 
 namespace Sstv.DomainExceptions.Extensions.DependencyInjection;
 
 /// <summary>
 /// Error codes description source from <see cref="IConfiguration"/>.
 /// </summary>
-[SuppressMessage("Design", "CA1812: Avoid uninstantiated internal classes")]
 public sealed class ErrorCodesDescriptionFromConfigurationSource : IErrorCodesDescriptionSource
 {
     /// <summary>
@@ -48,7 +46,7 @@ public ErrorCodesDescriptionFromConfigurationSource(IConfiguration configuration
 
         var description = section[nameof(ErrorDescription.Description)];
         var helpLink = section[nameof(ErrorDescription.HelpLink)];
-        var isObsolete = section.GetValue(nameof(ErrorDescription.IsObsolete), defaultValue: false);
+        var level = section.GetValue(nameof(ErrorDescription.Level), Level.Undefined);
 
         if (string.IsNullOrWhiteSpace(description))
         {
@@ -61,7 +59,7 @@ public ErrorCodesDescriptionFromConfigurationSource(IConfiguration configuration
             .Where(x => !string.IsNullOrWhiteSpace(x.Value))
             .ToDictionary(x => x.Key, x => (object)x.Value!);
 
-        return new ErrorDescription(errorCode, description, helpLink, isObsolete, additionalData);
+        return new ErrorDescription(errorCode, description, level, helpLink, additionalData);
     }
 
     /// <summary>

Sstv.DomainExceptions.Extensions.DependencyInjection/ErrorCodesMeter.cs

@@ -26,23 +26,25 @@ public static class ErrorCodesMeter
     /// <summary>
     /// Counts error codes.
     /// </summary>
-    /// <param name="domainException">Exception.</param>
-    public static void Measure(DomainException? domainException)
+    /// <param name="errorDescription">An error description.</param>
+    /// <param name="instance">An error instance.</param>
+    public static void Measure(ErrorDescription? errorDescription, object? instance)
     {
         if (!_counter.Enabled)
         {
             return;
         }
 
-        if (domainException is null)
+        if (errorDescription is null)
         {
             return;
         }
 
         var tagList = new TagList
         {
-            { "code", domainException.ErrorCode },
-            { "message", domainException.Message }
+            { "code", errorDescription.ErrorCode },
+            { "message", errorDescription.Description },
+            { "level", Enum.GetName(errorDescription.Level) }
         };
 
         _counter.Add(1, tagList);
@@ -51,25 +53,15 @@ public static void Measure(DomainException? domainException)
     /// <summary>
     /// Counts error codes.
     /// </summary>
-    /// <param name="errorDescription">An error description.</param>
-    public static void Measure(ErrorDescription? errorDescription)
+    /// <param name="domainException">Exception.</param>
+    [Obsolete("Use Measure(ErrorDescription?, object?) instead.")]
+    public static void Measure(DomainException? domainException)
     {
-        if (!_counter.Enabled)
-        {
-            return;
-        }
-
-        if (errorDescription is null)
+        if (domainException is null)
         {
             return;
         }
 
-        var tagList = new TagList
-        {
-            { "code", errorDescription.ErrorCode },
-            { "message", errorDescription.Description }
-        };
-
-        _counter.Add(1, tagList);
+        Measure(domainException.GetDescription(), domainException);
     }
 }

Sstv.DomainExceptions.Extensions.DependencyInjection/InitHostedService.cs

@@ -19,7 +19,7 @@ public InitHostedService(IServiceProvider sp, Action<IServiceProvider, DomainExc
 
         if (DomainExceptionSettings.Instance.CollectErrorCodesMetricAutomatically)
         {
-            DomainExceptionSettings.Instance.OnExceptionCreated += ErrorCodesMeter.Measure;
+            DomainExceptionSettings.Instance.OnErrorCreated += ErrorCodesMeter.Measure;
         }
 
         DomainExceptionSettings.ErrorDescriptionSourceGetter =

Sstv.DomainExceptions.Extensions.DependencyInjection/README.md

@@ -12,19 +12,19 @@ This library brings to Sstv.DomainExceptions additional capabilities to register
 You can install using Nuget Package Manager:
 
 ```bash
-Install-Package Sstv.DomainExceptions.Extensions.DependencyInjection -Version 2.2.0
+Install-Package Sstv.DomainExceptions.Extensions.DependencyInjection -Version 2.3.0
 ```
 
 via the .NET CLI:
 
 ```bash
-dotnet add package Sstv.DomainExceptions.Extensions.DependencyInjection --version 2.2.0
+dotnet add package Sstv.DomainExceptions.Extensions.DependencyInjection --version 2.3.0
 ```
 
 or you can add package reference manually:
 
 ```xml
-<PackageReference Include="Sstv.DomainExceptions.Extensions.DependencyInjection" Version="2.2.0" />
+<PackageReference Include="Sstv.DomainExceptions.Extensions.DependencyInjection" Version="2.3.0" />
 ```
 
 ## How to use?
@@ -46,13 +46,14 @@ services.AddDomainExceptions(builder =>
         settings.GenerateExceptionIdAutomatically = true;      // true by default
         settings.CollectErrorCodesMetricAutomatically = true;  // true by default
         settings.ThrowIfHasNoErrorCodeDescription = true;      // true by default
+        settings.AddCriticalityLevel = true;                   // true by default
 
         // manually provide you own singleton implementation of IErrorCodesDescriptionSource
         settings.ErrorCodesDescriptionSource = new MyAwesomeSource();
 
         // override default error description
         settings.DefaultErrorDescriptionProvider = 
-            errorCode => new ErrorDescription(errorCode, "N/A");
+            errorCode => new ErrorDescription(errorCode, "N/A", Level.Fatal);
     };
 });
 ```
@@ -69,9 +70,9 @@ services.AddDomainExceptions(bulder =>
     // or you can pass in memory dictionary
     bulder.WithErrorCodesDescriptionFromMemory(new Dictionary<string, ErrorDescription>
     {
-        ["SSTV.10004"] = new("SSTV.10004", "Some error description", "https://help.myproject.ru/error-codes/not-enough-money"),
-        ["SSTV.10005"] = new("SSTV.10005", "Another error", "https://help.myproject.ru/error-codes/SSTV.10005"),
-        ["SSTV.10006"] = new("SSTV.10006", "One more error", "https://help.myproject.ru/error-codes/SSTV.10006"),
+        ["SSTV.10004"] = new("SSTV.10004", "Some error description", Level.Fatal, "https://help.myproject.ru/error-codes/not-enough-money"),
+        ["SSTV.10005"] = new("SSTV.10005", "Another error", Level.Low, "https://help.myproject.ru/error-codes/SSTV.10005"),
+        ["SSTV.10006"] = new("SSTV.10006", "One more error", Level.Medium, "https://help.myproject.ru/error-codes/SSTV.10006"),
     });
 
     // or load from appsettings.json, and optionally set configuration section name.
@@ -91,11 +92,12 @@ Below example of appsettings.json, if you choose `WithErrorCodesDescriptionFromC
     "ErrorCodes": {
       "SSTV.10004": {
         "Description": "You have not enough money",
+        "Level": "Low",
         "HelpLink": "https://help.myproject.ru/error-codes/not-enough-money"
       },
       "SSTV.10005": {
-        "Description": "This is an obsolete error code from appsettings.json",
-        "IsObsolete": true
+        "Description": "This is high criticality level error code from appsettings.json",
+        "Level": "High"
       }
     }
   }
@@ -113,7 +115,7 @@ Sstv.DomainException expose public class `ErrorCodesMeter` with method `Measure`
 which called every time, when DomainException instantiated, and counts errors occured with OpenTelemetry counter metric:
 
 ```
-error_codes_total { code="SSTV.10004", message="You have not enough money" }
+error_codes_total { code="SSTV.10004", message="You have not enough money", level="Low" }
 ```
 
 This library have an extension method `AddDomainExceptionInstrumentation`, that can be called on `MeterProviderBuilder` to start collecting this metric.
@@ -182,29 +184,31 @@ output example:
 ```json
 // http://localhost:5115/error-codes
 {
-  "errorCodes": [
-    {
-      "code": "SSTV.10001",
-      "helpLink": "https://help.myproject.ru/error-codes/not-enough-money",
-      "message": "You have not enough money"
-    },
-    {
-      "code": "DIF.10003",
-      "helpLink": "https://help.myproject.ru/error-codes/DIF.10003",
-      "message": "Obsolete error code in enum",
-      "isObsolete": true
-    },
-    {
-      "code": "SSTV.10004",
-      "helpLink": "https://help.myproject.ru/error-codes/not-enough-money",
-      "message": "You have not enough money"
-    },
-    {
-      "code": "SSTV.10005",
-      "message": "This is an obsolete error code from appsettings.json",
-      "isObsolete": true
-    }
-  ]
+    "errorCodes": [
+        {
+            "code": "SSTV.10001",
+            "helpLink": "https://help.myproject.ru/error-codes/not-enough-money",
+            "message": "You have not enough money",
+            "level": "Low"
+        },
+        {
+            "code": "DIF.10003",
+            "helpLink": "https://help.myproject.ru/error-codes/DIF.10003",
+            "message": "Help link with template in enum member attribute",
+            "level": "Critical"
+        },
+        {
+            "code": "SSTV.10004",
+            "helpLink": "https://help.myproject.ru/error-codes/not-enough-money",
+            "message": "You have not enough money",
+            "level": "High"
+        },
+        {
+            "code": "SSTV.10005",
+            "message": "This is medium criticality level error code from appsettings.json",
+            "level": "Medium"
+        }
+    ]
 }
 ```
 

Sstv.DomainExceptions.Extensions.DependencyInjection/Sstv.DomainExceptions.Extensions.DependencyInjection.csproj

@@ -4,6 +4,10 @@
     <TargetFramework>net6.0</TargetFramework>
     <IsPackable>true</IsPackable>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>symbols.nupkg</SymbolPackageFormat>
+    <DocumentationFile>bin\$(Configuration)\$(MSBuildProjectName).xml</DocumentationFile>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -19,11 +23,11 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="MinVer" Version="4.3.0">
+    <PackageReference Include="MinVer" Version="6.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1">
+    <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.2.25">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>

Sstv.DomainExceptions.Extensions.ProblemDetails/CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.0] - 2024-12-06
+
+- No changes here
+
 ## [2.2.0] - 2024-02-18
 
 ### Added

Sstv.DomainExceptions.Extensions.ProblemDetails/README.md

@@ -12,19 +12,19 @@ This library brings to Sstv.DomainExceptions additional capabilities to create r
 You can install using Nuget Package Manager:
 
 ```bash
-Install-Package Sstv.DomainExceptions.Extensions.ProblemDetails -Version 2.2.0
+Install-Package Sstv.DomainExceptions.Extensions.ProblemDetails -Version 2.3.0
 ```
 
 via the .NET CLI:
 
 ```bash
-dotnet add package Sstv.DomainExceptions.Extensions.ProblemDetails --version 2.2.0
+dotnet add package Sstv.DomainExceptions.Extensions.ProblemDetails --version 2.3.0
 ```
 
 or you can add package reference manually:
 
 ```xml
-<PackageReference Include="Sstv.DomainExceptions.Extensions.ProblemDetails" Version="2.2.0" />
+<PackageReference Include="Sstv.DomainExceptions.Extensions.ProblemDetails" Version="2.3.0" />
 ```
 
 ## How to use?
@@ -84,6 +84,7 @@ throw ErrorCodes.NotEnoughMoney.ToException()
     "title": "You have not enough money",
     "status": 200,
     "code": "SSTV10001",
+    "criticalityLevel": "Low",
     "errorId": "ad3f064c-1254-41dd-82e4-891507937cf6"
 }
 ```