Separate metrics port (#288)

* Make Metrics configurable through appsettings.json and move endpoint to separate port * add missing trailing linebreaks
Altinn · Aug 17, 2023 · 6ce0799 · 6ce0799
1 parent 86a7377
commit 6ce0799
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 28 deletions.
diff --git a/src/Altinn.App.Api/Extensions/ServiceCollectionExtensions.cs b/src/Altinn.App.Api/Extensions/ServiceCollectionExtensions.cs
@@ -1,4 +1,6 @@
-using System;
+#nullable enable
+using System;
+using Altinn.App.Api.Configuration;
 using Altinn.App.Api.Controllers;
 using Altinn.App.Api.Infrastructure.Filters;
 using Altinn.App.Api.Infrastructure.Health;
@@ -18,6 +20,7 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.FeatureManagement;
 using Microsoft.IdentityModel.Tokens;
+using Prometheus;
 
 namespace Altinn.App.Api.Extensions
 {
@@ -74,6 +77,7 @@ public static void AddAltinnAppServices(this IServiceCollection services, IConfi
             services.AddHttpClient<AuthorizationApiClient>();
 
             services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
+            services.AddMetricsServer(config);
         }
 
         private static void AddApplicationInsights(IServiceCollection services, IConfiguration config, IWebHostEnvironment env)
@@ -144,5 +148,15 @@ private static void AddAntiforgery(IServiceCollection services)
 
             services.TryAddSingleton<ValidateAntiforgeryTokenIfAuthCookieAuthorizationFilter>();
         }
+
+        private static void AddMetricsServer(this IServiceCollection services, IConfiguration config)
+        {
+            var metricsSettings = config.GetSection("MetricsSettings").Get<MetricsSettings>() ?? new MetricsSettings();
+            if (metricsSettings.Enabled)
+            {
+                ushort port = metricsSettings.Port;
+                services.AddMetricServer(options => { options.Port = port; });
+            }
+        }
     }
-}
+}
diff --git a/src/Altinn.App.Api/Extensions/WebApplicationBuilderExtensions.cs b/src/Altinn.App.Api/Extensions/WebApplicationBuilderExtensions.cs
@@ -1,4 +1,6 @@
+#nullable enable
 using System.Reflection;
+using Altinn.App.Api.Configuration;
 using Altinn.App.Api.Helpers;
 using Prometheus;
 
@@ -16,20 +18,15 @@ public static class WebApplicationBuilderExtensions
     /// <returns></returns>
     public static IApplicationBuilder UseAltinnAppCommonConfiguration(this IApplicationBuilder app)
     {
+        var appId = StartupHelper.GetApplicationId();
         if (app is WebApplication webApp && webApp.Environment.IsDevelopment())
         {
             app.UseDeveloperExceptionPage();
+            webApp.UseAltinnPrometheus(appId);
         }
 
         app.UseHttpMetrics();
         app.UseMetricServer();
-        var appId = StartupHelper.GetApplicationId();
-        var version = Assembly.GetExecutingAssembly().GetName().Version?.ToString();
-        Metrics.DefaultRegistry.SetStaticLabels(new Dictionary<string, string>()
-        {
-            { "application_id", appId },
-            { "nuget_package_version", version }
-        });
         app.UseDefaultSecurityHeaders();
         app.UseRouting();
         app.UseStaticFiles('/' + appId);
@@ -43,4 +40,21 @@ public static IApplicationBuilder UseAltinnAppCommonConfiguration(this IApplicat
         app.UseHealthChecks("/health");
         return app;
     }
-}
+
+    private static void UseAltinnPrometheus(this WebApplication webApp, string appId)
+    {
+        var metricsSettings = webApp.Configuration.GetSection("MetricsSettings")?.Get<MetricsSettings>() ?? new MetricsSettings();
+        if (!metricsSettings.Enabled)
+        {
+            return;
+        }
+
+        webApp.UseHttpMetrics();
+        var version = Assembly.GetExecutingAssembly().GetName().Version?.ToString() ?? "unknown";
+        Metrics.DefaultRegistry.SetStaticLabels(new Dictionary<string, string>()
+        {
+            { "application_id", appId },
+            { "nuget_package_version", version }
+        });
+    }
+}
diff --git a/src/Altinn.App.Core/Configuration/MetricsSettings.cs b/src/Altinn.App.Core/Configuration/MetricsSettings.cs
@@ -0,0 +1,16 @@
+namespace Altinn.App.Api.Configuration;
+
+/// <summary>
+/// Metric settings for Altinn Apps
+/// </summary>
+public class MetricsSettings
+{
+    /// <summary>
+    /// Gets or sets a value indicating whether metrics is enabled or not
+    /// </summary>
+    public bool Enabled { get; set; } = true;
+    /// <summary>
+    /// Gets or sets the port for the metrics server is exposed
+    /// </summary>
+    public ushort Port { get; set; } = 5006;
+}
diff --git a/src/Altinn.App.Core/Extensions/ServiceCollectionExtensions.cs b/src/Altinn.App.Core/Extensions/ServiceCollectionExtensions.cs
@@ -1,3 +1,4 @@
+using Altinn.App.Api.Configuration;
 using Altinn.App.Core.Configuration;
 using Altinn.App.Core.Features;
 using Altinn.App.Core.Features.Action;
@@ -80,7 +81,6 @@ public static void AddPlatformServices(this IServiceCollection services, IConfig
             services.AddHttpClient<IDataClient, DataClient>();
             services.AddHttpClient<IOrganizationClient, RegisterERClient>();
             services.AddHttpClient<IInstanceClient, InstanceClient>();
-            services.Decorate<IInstanceClient, InstanceClientMetricsDecorator>();
             services.AddHttpClient<IInstanceEventClient, InstanceEventClient>();
             services.AddHttpClient<IEventsClient, EventsClient>();
             services.AddHttpClient<IPDF, PDFClient>();
@@ -162,6 +162,7 @@ public static void AddAppServices(this IServiceCollection services, IConfigurati
             AddProcessServices(services);
             AddFileAnalyserServices(services);
             AddFileValidatorServices(services);
+            AddMetricsDecorators(services, configuration);
 
             if (!env.IsDevelopment())
             {
@@ -236,7 +237,6 @@ private static void AddAppOptions(IServiceCollection services)
         private static void AddProcessServices(IServiceCollection services)
         {
             services.TryAddTransient<IProcessEngine, ProcessEngine>();
-            services.Decorate<IProcessEngine, ProcessEngineMetricsDecorator>();
             services.TryAddTransient<IProcessNavigator, ProcessNavigator>();
             services.TryAddSingleton<IProcessReader, ProcessReader>();
             services.TryAddTransient<IProcessEventDispatcher, ProcessEventDispatcher>();
@@ -264,5 +264,15 @@ private static void AddFileValidatorServices(IServiceCollection services)
             services.TryAddTransient<IFileValidationService, FileValidationService>();
             services.TryAddTransient<IFileValidatorFactory, FileValidatorFactory>();
         }
+
+        private static void AddMetricsDecorators(IServiceCollection services, IConfiguration configuration)
+        {
+            MetricsSettings metricsSettings = configuration.GetSection("MetricsSettings")?.Get<MetricsSettings>() ?? new MetricsSettings();
+            if (metricsSettings.Enabled)
+            {
+                services.Decorate<IInstanceClient, InstanceClientMetricsDecorator>();
+                services.Decorate<IProcessEngine, ProcessEngineMetricsDecorator>();
+            }
+        }
     }
 }
diff --git a/test/Altinn.App.Api.Tests/Program.cs b/test/Altinn.App.Api.Tests/Program.cs
@@ -24,6 +24,7 @@
 // external api's etc. should be mocked.
 
 WebApplicationBuilder builder = WebApplication.CreateBuilder(new WebApplicationOptions() { ApplicationName = "Altinn.App.Api.Tests" });
+builder.Configuration.GetSection("MetricsSettings:Enabled").Value = "false";
 ConfigureServices(builder.Services, builder.Configuration);
 ConfigureMockServices(builder.Services, builder.Configuration);
 
@@ -56,22 +57,7 @@ void ConfigureMockServices(IServiceCollection services, ConfigurationManager con
 
 void Configure()
 {
-    if (app.Environment.IsDevelopment())
-    {
-        app.UseDeveloperExceptionPage();
-    }
-
-    app.UseDefaultSecurityHeaders();
-    app.UseRouting();
-    app.UseStaticFiles();
-    app.UseAuthentication();
-    app.UseAuthorization();
-
-    app.UseEndpoints(endpoints =>
-    {
-        endpoints.MapControllers();
-    });
-    app.UseHealthChecks("/health");
+    app.UseAltinnAppCommonConfiguration();
 }
 
 // This "hack" (documentet by Microsoft) is done to