Enable Redis Logging

src/Components/Aspire.StackExchange.Redis/AspireRedisExtensions.cs

@@ -3,7 +3,6 @@
 
 global using System.Net.Security; // needed to work around https://github.com/dotnet/runtime/issues/94065
 
-using System.Text;
 using Aspire;
 using Aspire.StackExchange.Redis;
 using Microsoft.Extensions.Configuration;
@@ -89,12 +88,12 @@ private static void AddRedis(IHostApplicationBuilder builder, string configurati
         if (serviceKey is null)
         {
             builder.Services.AddSingleton<IConnectionMultiplexer>(
-                sp => ConnectionMultiplexer.Connect(GetConfigurationOptions(sp, connectionName, configurationSectionName, optionsName), CreateLogger(sp)));
+                sp => ConnectionMultiplexer.Connect(GetConfigurationOptions(sp, connectionName, configurationSectionName, optionsName)));
         }
         else
         {
             builder.Services.AddKeyedSingleton<IConnectionMultiplexer>(serviceKey,
-                (sp, key) => ConnectionMultiplexer.Connect(GetConfigurationOptions(sp, connectionName, configurationSectionName, optionsName), CreateLogger(sp)));
+                (sp, key) => ConnectionMultiplexer.Connect(GetConfigurationOptions(sp, connectionName, configurationSectionName, optionsName)));
         }
 
         if (settings.Tracing)
@@ -120,11 +119,6 @@ private static void AddRedis(IHostApplicationBuilder builder, string configurati
                     connectionMultiplexerFactory: sp => serviceKey is null ? sp.GetRequiredService<IConnectionMultiplexer>() : sp.GetRequiredKeyedService<IConnectionMultiplexer>(serviceKey),
                     healthCheckName));
         }
-
-        static TextWriter? CreateLogger(IServiceProvider serviceProvider)
-            => serviceProvider.GetService<ILoggerFactory>() is { } loggerFactory
-                ? new LoggingTextWriter(loggerFactory.CreateLogger("Aspire.StackExchange.Redis"))
-                : null;
     }
 
     private static ConfigurationOptions GetConfigurationOptions(IServiceProvider serviceProvider, string connectionName, string configurationSectionName, string? optionsName)
@@ -138,6 +132,9 @@ private static ConfigurationOptions GetConfigurationOptions(IServiceProvider ser
             throw new InvalidOperationException($"No endpoints specified. Ensure a valid connection string was provided in 'ConnectionStrings:{connectionName}' or for the '{configurationSectionName}:ConnectionString' configuration key.");
         }
 
+        // ensure the LoggerFactory is initialized if someone hasn't already set it.
+        configurationOptions.LoggerFactory ??= serviceProvider.GetService<ILoggerFactory>();
+
         return configurationOptions;
     }
 
@@ -149,13 +146,6 @@ private static ConfigurationOptions BindToConfiguration(ConfigurationOptions opt
         return options;
     }
 
-    private sealed class LoggingTextWriter(ILogger logger) : TextWriter
-    {
-        public override Encoding Encoding => Encoding.UTF8;
-
-        public override void Write(string? value) => logger.LogTrace(value);
-    }
-
     /// <summary>
     /// ConfigurationOptionsFactory parses a ConfigurationOptions options object from Configuration.
     /// </summary>

src/Components/Aspire.StackExchange.Redis/ConfigurationSchema.json

@@ -2,7 +2,7 @@
   "definitions": {
     "logLevel": {
       "properties": {
-        "Aspire.StackExchange.Redis": {
+        "StackExchange.Redis": {
           "$ref": "#/definitions/logLevelThreshold"
         }
       }

src/Components/Telemetry.md

@@ -220,7 +220,7 @@ Aspire.RabbitMQ.Client:
 
 Aspire.StackExchange.Redis:
 - Log categories:
-  - "Aspire.StackExchange.Redis" (this name is defined by our component, we can change it)
+  - "StackExchange.Redis"
 - Activity source names:
   - "OpenTelemetry.Instrumentation.StackExchangeRedis"
 - Metric names:

tests/Aspire.StackExchange.Redis.Tests/ConformanceTests.cs

@@ -20,7 +20,7 @@ public class ConformanceTests : ConformanceTests<IConnectionMultiplexer, StackEx
 
     protected override bool SupportsKeyedRegistrations => true;
 
-    protected override string[] RequiredLogCategories => new string[] { "Aspire.StackExchange.Redis" };
+    protected override string[] RequiredLogCategories => new string[] { "StackExchange.Redis" };
 
     // https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/e4cb523a4a3592e1a1adf30f3596025bfd8978e3/src/OpenTelemetry.Instrumentation.StackExchangeRedis/StackExchangeRedisConnectionInstrumentation.cs#L34
     protected override string ActivitySourceName => "OpenTelemetry.Instrumentation.StackExchangeRedis";