Merge pull request #618 from TransactionProcessing/task/#617_sentry_integration

Add Sentry integration and improve config handling

Author: StuartFerguson

.github/workflows/createrelease.yml

@@ -48,6 +48,10 @@ jobs:
     - name: Publish API
       if: ${{ github.event.release.prerelease == false }} 
       run: dotnet publish "TransactionProcessorACL\TransactionProcessorACL.csproj" --configuration Release --output publishOutput -r win-x64 --self-contained
+              -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

TransactionProcessorACL/Program.cs

@@ -2,20 +2,23 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using Shared.Logger;
+using Shared.Middleware;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
-using Shared.Logger;
-using Shared.Middleware;
 
 namespace TransactionProcessorACL
 {
     using Lamar.Microsoft.DependencyInjection;
     using NLog;
     using NLog.Extensions.Logging;
+    using Sentry.Extensibility;
+    using Shared.General;
     using System.Diagnostics.CodeAnalysis;
     using System.IO;
+    using System.Reflection;
 
     [ExcludeFromCodeCoverage]
     public class Program
@@ -60,6 +63,45 @@ public static IHostBuilder CreateHostBuilder(string[] args)
             });
             hostBuilder.ConfigureWebHostDefaults(webBuilder =>
                                                  {
+                                                     webBuilder.ConfigureAppConfiguration((context, configBuilder) =>
+                                                     {
+                                                         var env = context.HostingEnvironment;
+
+                                                         configBuilder.SetBasePath(fi.Directory.FullName)
+                                                             .AddJsonFile("hosting.json", optional: true)
+                                                             .AddJsonFile($"hosting.{env.EnvironmentName}.json", optional: true)
+                                                             .AddJsonFile("/home/txnproc/config/appsettings.json", optional: true, reloadOnChange: true)
+                                                             .AddJsonFile($"/home/txnproc/config/appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
+                                                             .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
+                                                             .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
+                                                             .AddEnvironmentVariables();
+
+                                                         // Build a snapshot of configuration so we can use it immediately (e.g. for Sentry)
+                                                         var builtConfig = configBuilder.Build();
+
+                                                         // Keep existing static usage (if you must), and initialise the ConfigurationReader now.
+                                                         Startup.Configuration = builtConfig;
+                                                         ConfigurationReader.Initialise(Startup.Configuration);
+
+                                                         // Configure Sentry on the webBuilder using the config snapshot.
+                                                         var sentrySection = builtConfig.GetSection("SentryConfiguration");
+                                                         if (sentrySection.Exists())
+                                                         {
+                                                             // Replace the condition below if you intended to only enable Sentry in certain environments.
+                                                             if (env.IsDevelopment() == false)
+                                                             {
+                                                                 webBuilder.UseSentry(o =>
+                                                                 {
+                                                                     o.Dsn = builtConfig["SentryConfiguration:Dsn"];
+                                                                     o.SendDefaultPii = true;
+                                                                     o.MaxRequestBodySize = RequestSize.Always;
+                                                                     o.CaptureBlockingCalls = true;
+                                                                     o.Release = Assembly.GetExecutingAssembly().GetName().Version?.ToString() ?? "unknown";
+                                                                 });
+                                                             }
+                                                         }
+                                                     });
+
                                                      webBuilder.UseStartup<Startup>();
                                                      webBuilder.UseConfiguration(config);
                                                      webBuilder.UseKestrel();

TransactionProcessorACL/Startup.cs

@@ -36,14 +36,6 @@ public class Startup
     {
         public Startup(IWebHostEnvironment webHostEnvironment)
         {
-            IConfigurationBuilder builder = new ConfigurationBuilder().SetBasePath(webHostEnvironment.ContentRootPath)
-                                                                      .AddJsonFile("/home/txnproc/config/appsettings.json", true, true)
-                                                                      .AddJsonFile($"/home/txnproc/config/appsettings.{webHostEnvironment.EnvironmentName}.json", optional: true)
-                                                                      .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
-                                                                      .AddJsonFile($"appsettings.{webHostEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true)
-                                                                      .AddEnvironmentVariables();
-
-            Startup.Configuration = builder.Build();
             Startup.WebHostEnvironment = webHostEnvironment;
         }
 

TransactionProcessorACL/TransactionProcessorACL.csproj

@@ -36,6 +36,7 @@
     <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="10.1.4" />
     <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.1.4" />
 	  <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="10.0.3" />
+	  <PackageReference Include="Sentry.AspNetCore" Version="6.2.0" />
   </ItemGroup>
 
   <ItemGroup>