feat(#130): render exception as a string property type (#135)

Author: followynne

samples/WebApi/Program.cs

@@ -46,6 +46,7 @@
     })
     .WithName("GetWeatherForecast")
     .WithOpenApi();
+app.MapGet("/exception", () => { throw new InvalidOperationException("This route doesn't exist!"); });
 
 app.Run();
 

samples/WebApi/WebApi.csproj

@@ -22,9 +22,9 @@
     <!-- Serilog UI packages  -->
     <ItemGroup>
         <!-- comment/uncomment to directly reference Nuget release
-        <PackageReference Include="Serilog.UI" Version="3.0.1"/>
-        <PackageReference Include="Serilog.UI.MsSqlServerProvider" Version="3.0.0"/>
-        <PackageReference Include="Serilog.UI.ElasticSearchProvider" Version="3.0.0"/>
+        <PackageReference Include="Serilog.UI" Version="3.1.0"/>
+        <PackageReference Include="Serilog.UI.MsSqlServerProvider" Version="3.1.0"/>
+        <PackageReference Include="Serilog.UI.ElasticSearchProvider" Version="3.1.0"/>
         -->
 
         <!-- comment/uncomment to directly reference solution projects -->

samples/WebApp/WebApp.csproj

@@ -38,8 +38,8 @@
     <!-- Serilog UI packages  -->
     <ItemGroup>
         <!-- comment/uncomment to directly reference Nuget release
-        <PackageReference Include="Serilog.UI" Version="3.0.1"/>
-        <PackageReference Include="Serilog.UI.MongoDbProvider" Version="3.0.0"/>
+        <PackageReference Include="Serilog.UI" Version="3.1.0"/>
+        <PackageReference Include="Serilog.UI.MongoDbProvider" Version="3.1.0"/>
         -->
 
         <!-- comment/uncomment to directly reference solution projects -->

src/Serilog.Ui.Core/Interfaces/ISerilogUiOptionsBuilder.cs

@@ -26,4 +26,10 @@ public interface ISerilogUiOptionsBuilder
     /// <param name="providerKey">The IDataProvider <see cref="IDataProvider.Name"/>.</param>
     /// <typeparam name="T"></typeparam>
     void RegisterColumnsInfo<T>(string providerKey) where T : LogModel;
+
+    /// <summary>
+    /// Register a Provider Key Name that saves the Exception field as string. 
+    /// </summary>
+    /// <param name="providerKey">The IDataProvider <see cref="IDataProvider.Name"/>.</param>
+    void RegisterExceptionAsStringForProviderKey(string providerKey);
 }

src/Serilog.Ui.Core/Models/Options/ProvidersOptions.cs

@@ -14,6 +14,8 @@ public class ProvidersOptions
 
     private readonly HashSet<string> _disabledSortProviderNames = [];
 
+    private readonly HashSet<string> _exceptionAsStringProviderNames = [];
+
     /// <summary>
     /// Gets the AdditionalColumns.
     /// </summary>
@@ -25,6 +27,11 @@ public class ProvidersOptions
     /// </summary>
     public IEnumerable<string> DisabledSortProviderNames => _disabledSortProviderNames.ToList().AsReadOnly();
 
+    /// <summary>
+    /// Gets the ExceptionAsStringProviderNames.
+    /// </summary>
+    public IEnumerable<string> ExceptionAsStringProviderNames => _exceptionAsStringProviderNames.ToList().AsReadOnly();
+
     internal void RegisterType<T>(string providerKey)
         where T : LogModel
     {
@@ -35,4 +42,9 @@ internal void RegisterDisabledSortName(string name)
     {
         _disabledSortProviderNames.Add(name);
     }
+
+    internal void RegisterExceptionAsStringProvider(string name)
+    {
+        _exceptionAsStringProviderNames.Add(name);
+    }
 }

src/Serilog.Ui.Core/OptionsBuilder/SerilogUiOptionsBuilder.cs

@@ -29,6 +29,12 @@ public void RegisterColumnsInfo<T>(string providerKey) where T : LogModel
         _providersOptions.RegisterType<T>(providerKey);
     }
 
+    /// <inheritdoc />
+    public void RegisterExceptionAsStringForProviderKey(string providerKey)
+    {
+        _providersOptions.RegisterExceptionAsStringProvider(providerKey);
+    }
+
     /// <summary>
     /// Register the <see cref="ProvidersOptions"/> in <see cref="IServiceCollection"/>.
     /// </summary>

src/Serilog.Ui.Core/Serilog.Ui.Core.csproj

@@ -3,7 +3,7 @@
 		<TargetFramework>netstandard2.0</TargetFramework>
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>
 		<LangVersion>latest</LangVersion>
-		<Version>3.0.0</Version>
+		<Version>3.1.0</Version>
 	</PropertyGroup>
 
 	<ItemGroup>

src/Serilog.Ui.ElasticSearchProvider/Serilog.Ui.ElasticSearchProvider.csproj

@@ -5,7 +5,7 @@
 
         <TargetFramework>netstandard2.0</TargetFramework>
         <LangVersion>latest</LangVersion>
-        <Version>3.0.0</Version>
+        <Version>3.1.0</Version>
 
         <Authors>Ricardo Demauro - rmauro.dev</Authors>
         <Description>ElasticSearch data provider for Serilog UI.</Description>

src/Serilog.Ui.MongoDbProvider/Serilog.Ui.MongoDbProvider.csproj

@@ -4,7 +4,7 @@
 		<PackageId>Serilog.UI.MongoDbProvider</PackageId>
 		<TargetFramework>netstandard2.0</TargetFramework>
 		<LangVersion>latest</LangVersion>
-		<Version>3.0.0</Version>
+		<Version>3.1.0</Version>
 
 		<Authors>Christian Haase</Authors>
 		<Description>MongoDB data provider for Serilog UI.</Description>

src/Serilog.Ui.MsSqlServerProvider/Extensions/SerilogUiOptionBuilderExtensions.cs

@@ -43,12 +43,15 @@ public static ISerilogUiOptionsBuilder UseSqlServer<T>(
             setupOptions(dbOptions);
             dbOptions.Validate();
 
+            var providerName = dbOptions.GetProviderName(SqlServerDataProvider.MsSqlProviderName);
+
+            optionsBuilder.RegisterExceptionAsStringForProviderKey(providerName);
             SqlMapper.AddTypeHandler(new DapperDateTimeHandler(dateTimeCustomParsing));
 
             var customModel = typeof(T) != typeof(SqlServerLogModel);
             if (customModel)
             {
-                optionsBuilder.RegisterColumnsInfo<T>(dbOptions.GetProviderName(SqlServerDataProvider.MsSqlProviderName));
+                optionsBuilder.RegisterColumnsInfo<T>(providerName);
                 optionsBuilder.Services.AddScoped<IDataProvider>(_ => new SqlServerDataProvider<T>(dbOptions));
 
                 return optionsBuilder;