Merge pull request #239 from TransactionProcessing/task/#238_sentry_integration

Add Sentry error tracking and versioning updates

Author: StuartFerguson

.github/workflows/createrelease.yml

@@ -47,7 +47,13 @@ jobs:
 
       - name: Publish API
         if: ${{ github.event.release.prerelease == false }} 
-        run: dotnet publish "CallbackHandler/CallbackHandler.csproj" --configuration Release --output publishOutput -r win-x64 --self-contained false
+        run: dotnet publish "CallbackHandler/CallbackHandler.csproj" 
+              --configuration Release --output publishOutput -r win-x64 
+              --self-contained false
+              -p:Version=${{ steps.get_version.outputs.VERSION }}
+              -p:AssemblyVersion${{ steps.get_version.outputs.VERSION }}
+              -p:FileVersion=${{ steps.get_version.outputs.VERSION }}
+              -p:InformationalVersion${{ steps.get_version.outputs.VERSION }}
 
       - name: Build Release Package
         run: |

CallbackHandler/CallbackHandler.csproj

@@ -12,6 +12,7 @@
 	  <PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0" />
     <PackageReference Include="MediatR" Version="14.1.0" />
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.23.0" />
+    <PackageReference Include="Sentry.AspNetCore" Version="6.2.0" />
     <PackageReference Include="Shared" Version="2026.3.1" />
     <PackageReference Include="Shared.Results.Web" Version="2026.3.1" />
     <PackageReference Include="SimpleResults.AspNetCore" Version="4.0.0" />

CallbackHandler/Handlers/CallbackHandlers.cs

@@ -3,18 +3,19 @@
 using CallbackHandlers.Models;
 using MediatR;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
 using Newtonsoft.Json;
+using Sentry;
 using Shared.Results;
+using Shared.Results.Web;
 using SimpleResults;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
 using System.Threading;
 using System.Threading.Tasks;
-using Microsoft.AspNetCore.Http.HttpResults;
-using Shared.Results.Web;
 
 namespace CallbackHandler.Handlers;
 
@@ -26,6 +27,10 @@ public static async Task<IResult> RecordCallback(Deposit depositCallback,
     {
         Guid callbackId = Guid.NewGuid();
 
+        if (depositCallback.Reference == "ExceptionTest") {
+            throw new Exception("This is a test exception");
+        }
+
         CallbackCommands.RecordCallbackCommand request = new(
             callbackId,
             JsonConvert.SerializeObject(depositCallback),

CallbackHandler/Program.cs

@@ -2,23 +2,28 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using NLog.Extensions.Logging;
+using Shared.General;
+using Shared.Logger;
+using Shared.Middleware;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
-using NLog.Extensions.Logging;
-using Shared.Logger;
-using Shared.Middleware;
+using JasperFx.CommandLine.Descriptions;
 
 namespace CallbackHandler
 {
     using Lamar.Microsoft.DependencyInjection;
     using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Options;
     using NLog;
+    using Sentry.Extensibility;
     using Shared.DomainDrivenDesign.EventSourcing;
     using Shared.EventStore.Aggregate;
     using System.Diagnostics.CodeAnalysis;
     using System.IO;
+    using System.Reflection;
 
     [ExcludeFromCodeCoverage]
     public class Program
@@ -68,7 +73,30 @@ public static IHostBuilder CreateHostBuilder(string[] args)
                                                      webBuilder.UseStartup<Startup>();
                                                      webBuilder.UseConfiguration(config);
                                                      webBuilder.UseKestrel();
+
+                                                     IConfigurationSection isSentryConfigured = config.GetSection("SentryConfiguration");
+                                                     if (isSentryConfigured.Exists()) {
+                                                         webBuilder.Configure((context,
+                                                                               app) => {
+                                                             if (context.HostingEnvironment.IsDevelopment() == false) {
+                                                                 Version version = Assembly.GetExecutingAssembly().GetName().Version;
+
+                                                                 webBuilder.UseSentry(o => {
+
+                                                                     o.Dsn = ConfigurationReader.GetValueFromSection<String>("SentryConfiguration", "Dsn");
+                                                                     o.SendDefaultPii = true; // required for body + user data
+                                                                     o.MaxRequestBodySize = RequestSize.Always;
+                                                                     o.CaptureBlockingCalls = true;
+                                                                     //o.CaptureFailedRequests = true;
+                                                                     o.Release = version != null ? version.ToString() : "unknown";
+
+                                                                 });
+                                                             }
+                                                         });
+
+                                                     }
                                                  });
+
             return hostBuilder;
         }
 

CallbackHandler/Startup.cs

@@ -1,8 +1,8 @@
+using CallbackHandler.Endpoints;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Hosting;
-using CallbackHandler.Endpoints;
 
 namespace CallbackHandler
 {
@@ -11,6 +11,7 @@ namespace CallbackHandler
     using Lamar;
     using Microsoft.AspNetCore.Diagnostics.HealthChecks;
     using Microsoft.Extensions.Logging;
+    using Sentry;
     using Shared.EventStore.Aggregate;
     using Shared.Extensions;
     using Shared.General;
@@ -80,7 +81,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerF
 
             Logger.Initialise(logger);
             Startup.Configuration.LogConfiguration(Logger.LogWarning);
-
+            
             ConfigurationReader.Initialise(Startup.Configuration);
             app.UseMiddleware<TenantMiddleware>();
             app.AddRequestResponseLogging();

CallbackHandler/appsettings.json

@@ -1,3 +1,3 @@
 {
-
+  
 }