feat: 新增慢連接日誌攔截器並調整相關方法參數

arenchen · arenchen · commit 83820200e115 · 2025-07-09T17:02:36.000+08:00
diff --git a/src/Netcorext.EntityFramework.UserIdentityPattern.AspNetCore/Extensions/ServiceCollectionExtension.cs b/src/Netcorext.EntityFramework.UserIdentityPattern.AspNetCore/Extensions/ServiceCollectionExtension.cs
@@ -1,40 +1,45 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.Extensions.DependencyInjection.Extensions;
-using Netcorext.Contracts;
 using Netcorext.EntityFramework.UserIdentityPattern.Interceptors;
 
 namespace Netcorext.EntityFramework.UserIdentityPattern.AspNetCore;
 
 public static class ServiceCollectionExtension
 {
-    private const long DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD = 1000;
+    private const long DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD = 100;
+    private const long DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD = 100;
 
-    public static IServiceCollection AddIdentityDbContext(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContext<IdentityReplicaDbContext<MasterContext>>(services, null, lifetime, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentityDbContext(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContext<IdentityReplicaDbContext<MasterContext>>(services, null, lifetime, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContext(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContext<IdentityReplicaDbContext<MasterContext>>(services, optionsAction, lifetime, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentityDbContext(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContext<IdentityReplicaDbContext<MasterContext>>(services, optionsAction, lifetime, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentitySlaveDbContext(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContext<IdentityReplicaDbContext<SlaveContext>>(services, null, lifetime, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentitySlaveDbContext(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContext<IdentityReplicaDbContext<SlaveContext>>(services, null, lifetime, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentitySlaveDbContext(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContext<IdentityReplicaDbContext<SlaveContext>>(services, optionsAction, lifetime, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentitySlaveDbContext(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContext<IdentityReplicaDbContext<SlaveContext>>(services, optionsAction, lifetime, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContext<TContext>(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+    public static IServiceCollection AddIdentityDbContext<TContext>(this IServiceCollection services, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
         where TContext : DatabaseContext =>
-        AddIdentityDbContext<TContext>(services, null, lifetime, slowCommandLoggingThreshold);
+        AddIdentityDbContext<TContext>(services, null, lifetime, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContext<TContext>(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+    public static IServiceCollection AddIdentityDbContext<TContext>(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, ServiceLifetime lifetime = ServiceLifetime.Scoped, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
         where TContext : DatabaseContext
     {
         services.AddContextState();
 
         services.AddDbContext<TContext>((provider, builder) =>
                                         {
                                             var loggerFactory = provider.GetRequiredService<ILoggerFactory>();
-                                            builder.AddInterceptors(new SlowCommandLoggingInterceptor(loggerFactory, slowCommandLoggingThreshold));
+
+                                            builder.AddInterceptors(
+                                                                    new SlowConnectionLoggingInterceptor(loggerFactory, slowConnectionLoggingThreshold),
+                                                                    new SlowCommandLoggingInterceptor(loggerFactory, slowCommandLoggingThreshold)
+                                                                   );
+
                                             optionsAction?.Invoke(provider, builder);
                                         }, lifetime);
 
@@ -47,31 +52,36 @@ public static IServiceCollection AddIdentityDbContext<TContext>(this IServiceCol
         return services;
     }
 
-    public static IServiceCollection AddIdentityDbContextPool(this IServiceCollection services, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContextPool<IdentityReplicaDbContext<MasterContext>>(services, null, poolSize, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentityDbContextPool(this IServiceCollection services, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContextPool<IdentityReplicaDbContext<MasterContext>>(services, null, poolSize, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContextPool(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContextPool<IdentityReplicaDbContext<MasterContext>>(services, optionsAction, poolSize, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentityDbContextPool(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContextPool<IdentityReplicaDbContext<MasterContext>>(services, optionsAction, poolSize, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentitySlaveDbContextPool(this IServiceCollection services, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContextPool<IdentityReplicaDbContext<SlaveContext>>(services, null, poolSize, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentitySlaveDbContextPool(this IServiceCollection services, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContextPool<IdentityReplicaDbContext<SlaveContext>>(services, null, poolSize, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentitySlaveDbContextPool(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
-        => AddIdentityDbContextPool<IdentityReplicaDbContext<SlaveContext>>(services, optionsAction, poolSize, slowCommandLoggingThreshold);
+    public static IServiceCollection AddIdentitySlaveDbContextPool(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+        => AddIdentityDbContextPool<IdentityReplicaDbContext<SlaveContext>>(services, optionsAction, poolSize, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContextPool<TContext>(this IServiceCollection services, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+    public static IServiceCollection AddIdentityDbContextPool<TContext>(this IServiceCollection services, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
         where TContext : DatabaseContext =>
-        AddIdentityDbContextPool<TContext>(services, null, poolSize, slowCommandLoggingThreshold);
+        AddIdentityDbContextPool<TContext>(services, null, poolSize, slowConnectionLoggingThreshold, slowCommandLoggingThreshold);
 
-    public static IServiceCollection AddIdentityDbContextPool<TContext>(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
+    public static IServiceCollection AddIdentityDbContextPool<TContext>(this IServiceCollection services, Action<IServiceProvider, DbContextOptionsBuilder>? optionsAction, int poolSize = 1024, long slowConnectionLoggingThreshold = DEFAULT_SLOW_CONNECTION_LOGGING_THRESHOLD, long slowCommandLoggingThreshold = DEFAULT_SLOW_COMMAND_LOGGING_THRESHOLD)
         where TContext : DatabaseContext
     {
         services.AddContextState();
 
         services.AddDbContextPool<TContext>((provider, builder) =>
                                             {
                                                 var loggerFactory = provider.GetRequiredService<ILoggerFactory>();
-                                                builder.AddInterceptors(new SlowCommandLoggingInterceptor(loggerFactory, slowCommandLoggingThreshold));
+
+                                                builder.AddInterceptors(
+                                                                        new SlowConnectionLoggingInterceptor(loggerFactory, slowConnectionLoggingThreshold),
+                                                                        new SlowCommandLoggingInterceptor(loggerFactory, slowCommandLoggingThreshold)
+                                                                       );
+
                                                 optionsAction?.Invoke(provider, builder);
                                             }, poolSize);
 
diff --git a/src/Netcorext.EntityFramework.UserIdentityPattern/Interceptors/SlowCommandLoggingInterceptor.cs b/src/Netcorext.EntityFramework.UserIdentityPattern/Interceptors/SlowCommandLoggingInterceptor.cs
@@ -61,7 +61,7 @@ private void LogSlowCommand(string commandText, TimeSpan duration)
     {
         if (duration.TotalMilliseconds > _slowCommandLoggingThreshold)
         {
-            _logger.LogWarning("Slow DbCommand ({Duration})\n{CommandText} ()", duration, commandText);
+            _logger.LogWarning("Detected slow SQL command: ({Duration})\n{CommandText} ()", duration, commandText);
         }
     }
-}
+}
diff --git a/src/Netcorext.EntityFramework.UserIdentityPattern/Interceptors/SlowConnectionLoggingInterceptor.cs b/src/Netcorext.EntityFramework.UserIdentityPattern/Interceptors/SlowConnectionLoggingInterceptor.cs
@@ -0,0 +1,37 @@
+using System.Data.Common;
+using Microsoft.EntityFrameworkCore.Diagnostics;
+using Microsoft.Extensions.Logging;
+
+namespace Netcorext.EntityFramework.UserIdentityPattern.Interceptors;
+
+public class SlowConnectionLoggingInterceptor : DbConnectionInterceptor
+{
+    private readonly ILogger<SlowConnectionLoggingInterceptor> _logger;
+    private readonly long _slowConnectionLoggingThreshold;
+
+    public SlowConnectionLoggingInterceptor(ILoggerFactory loggerFactory, long slowConnectionLoggingThreshold)
+    {
+        _logger = loggerFactory.CreateLogger<SlowConnectionLoggingInterceptor>();
+        _slowConnectionLoggingThreshold = slowConnectionLoggingThreshold;
+    }
+
+    public override void ConnectionOpened(DbConnection connection, ConnectionEndEventData eventData)
+    {
+        LogSlowConnection(connection.DataSource, connection.Database, eventData.Duration);
+        base.ConnectionOpened(connection, eventData);
+    }
+
+    public override Task ConnectionOpenedAsync(DbConnection connection, ConnectionEndEventData eventData, CancellationToken cancellationToken = new CancellationToken())
+    {
+        LogSlowConnection(connection.DataSource, connection.Database, eventData.Duration);
+        return base.ConnectionOpenedAsync(connection, eventData, cancellationToken);
+    }
+
+    private void LogSlowConnection(string dataSource, string database, TimeSpan duration)
+    {
+        if (duration.TotalMilliseconds > _slowConnectionLoggingThreshold)
+        {
+            _logger.LogWarning("Detected slow database connection: DataSource={dataSource}, Database={database} ({Duration})", duration, dataSource, database);
+        }
+    }
+}
diff --git a/src/Versioning.targets b/src/Versioning.targets
@@ -3,7 +3,7 @@
     <LangVersion>latest</LangVersion>
     <VersionMajor>1</VersionMajor>
     <VersionMinor>0</VersionMinor>
-    <VersionPatch>0</VersionPatch>
+    <VersionPatch>1</VersionPatch>
     <VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
     <VersionSuffix>$(VersionSuffix)</VersionSuffix>
     <FileVersion>$(VersionMajor).$([System.DateTime]::UtcNow.ToString(yy)).$([System.DateTime]::UtcNow.ToString(MMdd)).$([System.DateTime]::UtcNow.ToString(HHmm))</FileVersion>
@@ -27,4 +27,4 @@
     </ItemGroup>
   </Target>
 
-</Project>
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ private void LogSlowCommand(string commandText, TimeSpan duration)`
`61`	`61`	`{`
`62`	`62`	`if (duration.TotalMilliseconds > _slowCommandLoggingThreshold)`
`63`	`63`	`{`
`64`		`- _logger.LogWarning("Slow DbCommand ({Duration})\n{CommandText} ()", duration, commandText);`
	`64`	`+ _logger.LogWarning("Detected slow SQL command: ({Duration})\n{CommandText} ()", duration, commandText);`
`65`	`65`	`}`
`66`	`66`	`}`
`67`		`-}`
	`67`	`+}`