Add test for logging registration, add try/catch around sending error to telemetry

Author: JamesNK

src/Aspire.Dashboard/Telemetry/TelemetryLoggerProvider.cs

@@ -28,15 +28,13 @@ public void Dispose()
 
     private sealed class TelemetryLogger : ILogger
     {
-        private readonly DashboardTelemetryService? _telemetryService;
+        private readonly IServiceProvider _serviceProvider;
+        private readonly bool _isCircuitHostLogger;
 
         public TelemetryLogger(IServiceProvider serviceProvider, string categoryName)
         {
-            if (categoryName == CircuitHostLogCategory)
-            {
-                // Set this lazily to avoid a circular reference between resolving telemetry service and logging.
-                _telemetryService = serviceProvider.GetRequiredService<DashboardTelemetryService>();
-            }
+            _serviceProvider = serviceProvider;
+            _isCircuitHostLogger = categoryName == CircuitHostLogCategory;
         }
 
         public IDisposable? BeginScope<TState>(TState state) where TState : notnull => null;
@@ -45,19 +43,30 @@ public TelemetryLogger(IServiceProvider serviceProvider, string categoryName)
 
         public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
         {
-            if (_telemetryService != null && eventId == CircuitUnhandledExceptionEventId && exception != null)
+            if (_isCircuitHostLogger && eventId == CircuitUnhandledExceptionEventId && exception != null)
             {
-                _telemetryService.PostFault(
-                    TelemetryEventKeys.Error,
-                    $"{exception.GetType().FullName}: {exception.Message}",
-                    FaultSeverity.Critical,
-                    new Dictionary<string, AspireTelemetryProperty>
-                    {
-                        [TelemetryPropertyKeys.ExceptionType] = new AspireTelemetryProperty(exception.GetType().FullName!),
-                        [TelemetryPropertyKeys.ExceptionMessage] = new AspireTelemetryProperty(exception.Message),
-                        [TelemetryPropertyKeys.ExceptionStackTrace] = new AspireTelemetryProperty(exception.StackTrace ?? string.Empty)
-                    }
-                );
+                try
+                {
+                    // Get the telemetry service lazily to avoid a circular reference between resolving telemetry service and logging.
+                    var telemetryService = _serviceProvider.GetRequiredService<DashboardTelemetryService>();
+
+                    telemetryService.PostFault(
+                        TelemetryEventKeys.Error,
+                        $"{exception.GetType().FullName}: {exception.Message}",
+                        FaultSeverity.Critical,
+                        new Dictionary<string, AspireTelemetryProperty>
+                        {
+                            [TelemetryPropertyKeys.ExceptionType] = new AspireTelemetryProperty(exception.GetType().FullName!),
+                            [TelemetryPropertyKeys.ExceptionMessage] = new AspireTelemetryProperty(exception.Message),
+                            [TelemetryPropertyKeys.ExceptionStackTrace] = new AspireTelemetryProperty(exception.StackTrace ?? string.Empty)
+                        }
+                    );
+                }
+                catch
+                {
+                    // We should never throw an error out of logging.
+                    // Logging the error to telemetry shouldn't throw. But, for extra safety, send error to telemetry is inside a try/catch.
+                }
             }
         }
     }

tests/Aspire.Dashboard.Tests/Integration/StartupTests.cs

@@ -6,6 +6,7 @@
 using System.Text.Json.Nodes;
 using Aspire.Dashboard.Configuration;
 using Aspire.Dashboard.Otlp.Http;
+using Aspire.Dashboard.Telemetry;
 using Aspire.Hosting;
 using Aspire.Tests.Shared.Telemetry;
 using Google.Protobuf;
@@ -15,6 +16,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
+using Microsoft.Extensions.Logging.Console;
 using Microsoft.Extensions.Logging.Testing;
 using Microsoft.Extensions.Options;
 using Microsoft.Net.Http.Headers;
@@ -765,6 +767,20 @@ public async Task Configuration_DisableResourceGraph_EnsureValueSetOnOptions(boo
         // Assert
         Assert.Equal(value, app.DashboardOptionsMonitor.CurrentValue.UI.DisableResourceGraph);
     }
+    [Fact]
+    public async Task ServiceProvider_AppCreated_LoggerProvidersRegistered()
+    {
+        // Arrange
+        await using var app = IntegrationTestHelpers.CreateDashboardWebApplication(testOutputHelper);
+
+        // Act
+        var loggerProviders = app.Services.GetServices<ILoggerProvider>();
+        var loggerProviderTypes = loggerProviders.Select(p => p.GetType()).ToList();
+
+        // Assert
+        Assert.Contains(typeof(TelemetryLoggerProvider), loggerProviderTypes);
+        Assert.Contains(typeof(ConsoleLoggerProvider), loggerProviderTypes);
+    }
 
     private static void AssertIPv4OrIPv6Endpoint(Func<EndpointInfo> endPointAccessor)
     {