Improve telemetry (#39)

Mark 404, 403, 401, 429 as successful
Drop request durations for websockets

GuildWarsPartySearch/Attributes/OptionsNameAttribute.cs

@@ -0,0 +1,7 @@
+namespace GuildWarsPartySearch.Server.Attributes;
+
+[AttributeUsage(AttributeTargets.Class)]
+public sealed class OptionsNameAttribute : Attribute
+{
+    public string? Name { get; set; }
+}

GuildWarsPartySearch/Config.Debug.json

@@ -54,5 +54,13 @@
   },
   "ApplicationInsights": {
     "InstrumentationKey": "[AZURE_INSIGHTS_INSTRUMENTATIONKEY]"
+  },
+  "TelemetryOptions": {
+    "SuccessfulStatusCodes": [
+      401,
+      403,
+      404,
+      429
+    ]
   }
 }

GuildWarsPartySearch/Config.Release.json

@@ -54,5 +54,13 @@
   },
   "ApplicationInsights": {
     "InstrumentationKey": "[AZURE_INSIGHTS_INSTRUMENTATIONKEY]"
+  },
+  "TelemetryOptions": {
+    "SuccessfulStatusCodes": [
+      401,
+      403,
+      404,
+      429
+    ]
   }
 }

GuildWarsPartySearch/Extensions/WebApplicationBuilderExtensions.cs

@@ -0,0 +1,28 @@
+using GuildWarsPartySearch.Server.Attributes;
+using System.Core.Extensions;
+using System.Extensions;
+
+namespace GuildWarsPartySearch.Server.Extensions;
+
+public static class WebApplicationBuilderExtensions
+{
+    public static WebApplicationBuilder ConfigureExtended<TOptions>(this WebApplicationBuilder builder)
+        where TOptions : class, new()
+    {
+        builder.ThrowIfNull()
+               .Services.Configure<TOptions>(builder.Configuration.GetSection(GetOptionsName<TOptions>()));
+        return builder;
+    }
+
+    private static string GetOptionsName<TOptions>()
+    {
+        var maybeAttribute = typeof(TOptions).GetCustomAttributes(false).OfType<OptionsNameAttribute>().FirstOrDefault();
+        if (maybeAttribute is not null &&
+            maybeAttribute.Name?.IsNullOrWhiteSpace() is false)
+        {
+            return maybeAttribute.Name;
+        }
+
+        return typeof(TOptions).Name;
+    }
+}

GuildWarsPartySearch/Extensions/WebApplicationExtensions.cs

@@ -73,6 +73,7 @@ private static async Task ProcessWebSocketRequest(WebSocketRouteBase route, Http
         route.WebSocket = webSocket;
         route.Context = httpContext;
         await route.SocketAccepted(httpContext.RequestAborted);
+        httpContext.Request.Scheme = httpContext.Request.Scheme == "https" ? "wss" : "ws";
         await HandleWebSocket(webSocket, route, httpContext.RequestAborted);
         await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing", httpContext.RequestAborted);
     }

GuildWarsPartySearch/Launch/ServerConfiguration.cs

@@ -11,6 +11,8 @@
 using GuildWarsPartySearch.Server.Services.Feed;
 using GuildWarsPartySearch.Server.Services.Lifetime;
 using GuildWarsPartySearch.Server.Services.PartySearch;
+using GuildWarsPartySearch.Server.Telemetry;
+using Microsoft.ApplicationInsights.Extensibility;
 using Microsoft.Extensions.Azure;
 using Microsoft.Extensions.Options;
 using System.Core.Extensions;
@@ -62,23 +64,24 @@ public static ILoggingBuilder SetupLogging(this ILoggingBuilder builder)
 
     public static WebApplicationBuilder SetupOptions(this WebApplicationBuilder builder)
     {
-        builder.ThrowIfNull()
-            .Services.Configure<EnvironmentOptions>(builder.Configuration.GetSection(nameof(EnvironmentOptions)))
-                     .Configure<ContentOptions>(builder.Configuration.GetSection(nameof(ContentOptions)))
-                     .Configure<PartySearchTableOptions>(builder.Configuration.GetSection(nameof(PartySearchTableOptions)))
-                     .Configure<StorageAccountOptions>(builder.Configuration.GetSection(nameof(StorageAccountOptions)))
-                     .Configure<ServerOptions>(builder.Configuration.GetSection(nameof(ServerOptions)))
-                     .Configure<IpRateLimitOptions>(builder.Configuration.GetSection(nameof(IpRateLimitOptions)))
-                     .Configure<IpRateLimitPolicies>(builder.Configuration.GetSection(nameof(IpRateLimitPolicies)));
-
-        return builder;
+        return builder.ThrowIfNull()
+            .ConfigureExtended<EnvironmentOptions>()
+            .ConfigureExtended<ContentOptions>()
+            .ConfigureExtended<PartySearchTableOptions>()
+            .ConfigureExtended<StorageAccountOptions>()
+            .ConfigureExtended<ServerOptions>()
+            .ConfigureExtended<IpRateLimitOptions>()
+            .ConfigureExtended<IpRateLimitPolicies>()
+            .ConfigureExtended<TelemetryOptions>();
     }
 
     public static IServiceCollection SetupServices(this IServiceCollection services)
     {
         services.ThrowIfNull();
 
         services.AddApplicationInsightsTelemetry();
+        services.AddSingleton<ITelemetryInitializer, Mark4xxAsSuccessfulTelemetryInitializer>();
+        services.AddApplicationInsightsTelemetryProcessor<WebSocketTelemetryProcessor>();
         services.AddMemoryCache();
         services.AddInMemoryRateLimiting();
         services.AddScoped<ApiKeyProtected>();

GuildWarsPartySearch/Options/ContentOptions.cs

@@ -1,8 +1,15 @@
-namespace GuildWarsPartySearch.Server.Options;
+using System.Text.Json.Serialization;
+
+namespace GuildWarsPartySearch.Server.Options;
 
 public sealed class ContentOptions : IAzureBlobStorageOptions
 {
+    [JsonPropertyName(nameof(UpdateFrequency))]
     public TimeSpan UpdateFrequency { get; set; } = TimeSpan.FromMinutes(5);
+
+    [JsonPropertyName(nameof(StagingFolder))]
     public string StagingFolder { get; set; } = "Content";
+
+    [JsonPropertyName(nameof(ContainerName))]
     public string ContainerName { get; set; } = default!;
 }

GuildWarsPartySearch/Options/EnvironmentOptions.cs

@@ -1,6 +1,9 @@
-namespace GuildWarsPartySearch.Server.Options;
+using System.Text.Json.Serialization;
+
+namespace GuildWarsPartySearch.Server.Options;
 
 public sealed class EnvironmentOptions
 {
+    [JsonPropertyName(nameof(Name))]
     public string? Name { get; init; }
 }

GuildWarsPartySearch/Options/PartySearchTableOptions.cs

@@ -1,6 +1,9 @@
-namespace GuildWarsPartySearch.Server.Options;
+using System.Text.Json.Serialization;
+
+namespace GuildWarsPartySearch.Server.Options;
 
 public class PartySearchTableOptions : IAzureTableStorageOptions
 {
+    [JsonPropertyName(nameof(TableName))]
     public string TableName { get; set; } = default!;
 }

GuildWarsPartySearch/Options/ServerOptions.cs

@@ -1,18 +1,18 @@
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 namespace GuildWarsPartySearch.Server.Options;
 
 public sealed class ServerOptions
 {
-    [JsonProperty(nameof(Certificate))]
+    [JsonPropertyName(nameof(Certificate))]
     public string? Certificate { get; set; }
 
-    [JsonProperty(nameof(ApiKey))]
+    [JsonPropertyName(nameof(ApiKey))]
     public string? ApiKey { get; set; }
 
-    [JsonProperty(nameof(InactivityTimeout))]
+    [JsonPropertyName(nameof(InactivityTimeout))]
     public TimeSpan? InactivityTimeout { get; set; }
 
-    [JsonProperty(nameof(HeartbeatFrequency))]
+    [JsonPropertyName(nameof(HeartbeatFrequency))]
     public TimeSpan? HeartbeatFrequency { get; set; }
 }

GuildWarsPartySearch/Options/StorageAccountOptions.cs

@@ -1,15 +1,15 @@
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 namespace GuildWarsPartySearch.Server.Options;
 
 public sealed class StorageAccountOptions
 {
-    [JsonProperty(nameof(TableName))]
+    [JsonPropertyName(nameof(TableName))]
     public string? TableName { get; set; }
 
-    [JsonProperty(nameof(ConnectionString))]
+    [JsonPropertyName(nameof(ConnectionString))]
     public string? ConnectionString { get; set; }
 
-    [JsonProperty(nameof(ContainerName))]
+    [JsonPropertyName(nameof(ContainerName))]
     public string? ContainerName { get; set; }
 }

GuildWarsPartySearch/Options/TelemetryOptions.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace GuildWarsPartySearch.Server.Options;
+
+public sealed class TelemetryOptions
+{
+    [JsonPropertyName(nameof(SuccessfulStatusCodes))]
+    public List<int>? SuccessfulStatusCodes { get; set; }
+}

GuildWarsPartySearch/Telemetry/Mark4xxAsSuccessfulTelemetryInitializer.cs

@@ -0,0 +1,39 @@
+using GuildWarsPartySearch.Server.Options;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.ApplicationInsights.Extensibility;
+using Microsoft.Extensions.Options;
+using System.Core.Extensions;
+
+namespace GuildWarsPartySearch.Server.Telemetry;
+
+public sealed class Mark4xxAsSuccessfulTelemetryInitializer : ITelemetryInitializer
+{
+    private readonly TelemetryOptions telemetryOptions;
+
+    public Mark4xxAsSuccessfulTelemetryInitializer(
+        IOptions<TelemetryOptions> options)
+    {
+        this.telemetryOptions = options.ThrowIfNull().Value;
+    }
+
+    public void Initialize(ITelemetry telemetry)
+    {
+        if (telemetry is not RequestTelemetry requestTelemetry)
+        {
+            return;
+        }
+
+        if (!int.TryParse(requestTelemetry.ResponseCode, out var statusCode))
+        {
+            return;
+        }
+
+        if (this.telemetryOptions.SuccessfulStatusCodes?.Contains(statusCode) is true)
+        {
+            requestTelemetry.Success = true;
+        }
+
+        return;
+    }
+}

GuildWarsPartySearch/Telemetry/WebSocketTelemetryProcessor.cs

@@ -0,0 +1,31 @@
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.ApplicationInsights.Extensibility;
+using System.Core.Extensions;
+
+namespace GuildWarsPartySearch.Server.Telemetry;
+
+public sealed class WebSocketTelemetryProcessor : ITelemetryProcessor
+{
+    private readonly ITelemetryProcessor next;
+
+    public WebSocketTelemetryProcessor(ITelemetryProcessor next)
+    {
+        this.next = next.ThrowIfNull();
+    }
+
+    public void Process(ITelemetry item)
+    {
+        if (item is not RequestTelemetry request)
+        {
+            return;
+        }
+
+        if (request.Url.Scheme is "ws" or "wss")
+        {
+            request.Duration = TimeSpan.Zero;
+        }
+
+        this.next.Process(item);
+    }
+}