feat: SqlQuery 增加 诊断信息

Author: jianxuanbing

Bing.All.sln

@@ -228,9 +228,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Test.Shared", "framewo
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Ddd.Domain.Tests", "framework\tests\Bing.Ddd.Domain.Tests\Bing.Ddd.Domain.Tests.csproj", "{8B581529-D7D2-4DCF-824A-2AAFB58F8C94}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bing.EventBus", "framework\src\Bing.EventBus\Bing.EventBus.csproj", "{5E8AD211-7AEF-4D9D-AFA8-C85B6F3D7C6A}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.EventBus", "framework\src\Bing.EventBus\Bing.EventBus.csproj", "{5E8AD211-7AEF-4D9D-AFA8-C85B6F3D7C6A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bing.EventBus.Tests", "framework\tests\Bing.EventBus.Tests\Bing.EventBus.Tests.csproj", "{0A5D1639-8EEE-4BC9-94A5-04F354FEFBFD}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.EventBus.Tests", "framework\tests\Bing.EventBus.Tests\Bing.EventBus.Tests.csproj", "{0A5D1639-8EEE-4BC9-94A5-04F354FEFBFD}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

framework/src/Bing.Data.Sql/Bing/Data/Sql/Diagnostics/DiagnosticsMessage.cs

@@ -0,0 +1,56 @@
+using System;
+using Bing.Data.Enums;
+
+namespace Bing.Data.Sql.Diagnostics
+{
+    /// <summary>
+    /// 诊断消息
+    /// </summary>
+    public class DiagnosticsMessage
+    {
+        /// <summary>
+        /// 操作时间戳
+        /// </summary>
+        public long? OperationTimestamp { get; set; }
+
+        /// <summary>
+        /// 操作
+        /// </summary>
+        public string Operation { get; set; }
+
+        /// <summary>
+        /// 操作标识
+        /// </summary>
+        public string OperationId { get; set; } = Guid.NewGuid().ToString();
+
+        /// <summary>
+        /// Sql语句
+        /// </summary>
+        public string Sql { get; set; }
+
+        /// <summary>
+        /// Sql参数
+        /// </summary>
+        public object Parameters { get; set; }
+
+        /// <summary>
+        /// 数据库类型
+        /// </summary>
+        public DatabaseType DatabaseType { get; set; }
+
+        /// <summary>
+        /// 数据库数据源
+        /// </summary>
+        public string DataSource { get; set; }
+
+        /// <summary>
+        /// 耗时
+        /// </summary>
+        public long? ElapsedMilliseconds { get; set; }
+
+        /// <summary>
+        /// 异常
+        /// </summary>
+        public Exception Exception { get; set; }
+    }
+}

framework/src/Bing.Data.Sql/Bing/Data/Sql/Diagnostics/SqlQueryDiagnosticListenerNames.cs

@@ -0,0 +1,43 @@
+namespace Bing.Data.Sql.Diagnostics
+{
+    /// <summary>
+    /// 诊断常量
+    /// </summary>
+    public class SqlQueryDiagnosticListenerNames
+    {
+        /// <summary>
+        /// 前缀
+        /// </summary>
+        public const string Prefix = "Bing.SqlQuery.";
+
+        /// <summary>
+        /// 监听名称
+        /// </summary>
+        public const string DiagnosticListenerName = "SqlQueryDiagnosticListener";
+
+        /// <summary>
+        /// 执行前
+        /// </summary>
+        public const string BeforeExecute = Prefix + "ExecuteBefore";
+
+        /// <summary>
+        /// 执行后
+        /// </summary>
+        public const string AfterExecute = Prefix + "ExecuteAfter";
+
+        /// <summary>
+        /// 执行异常
+        /// </summary>
+        public const string ErrorExecute = Prefix + "ExecuteError";
+
+        /// <summary>
+        /// 执行数据库连接释放
+        /// </summary>
+        public const string DisposeExecute = Prefix + "ExecuteDispose";
+
+        /// <summary>
+        /// 数据库连接释放异常
+        /// </summary>
+        public const string DisposeException = Prefix + "DisposeException";
+    }
+}

framework/src/Bing.Data.Sql/Bing/Data/Sql/Queries/SqlQueryBase.Diagnostics.cs

@@ -0,0 +1,70 @@
+using System;
+using System.Diagnostics;
+using Bing.Data.Sql.Diagnostics;
+
+namespace Bing.Data.Sql.Queries
+{
+    // Sql查询对象 - 诊断相关
+    public abstract partial class SqlQueryBase
+    {
+        /// <summary>
+        /// 诊断日志
+        /// </summary>
+        // ReSharper disable once InconsistentNaming
+        private static readonly DiagnosticListener _diagnosticListener = new DiagnosticListener(SqlQueryDiagnosticListenerNames.DiagnosticListenerName);
+
+        /// <summary>
+        /// 执行前诊断
+        /// </summary>
+        /// <param name="sql">Sql语句</param>
+        /// <param name="parameter">Sql参数</param>
+        /// <param name="dataSource">数据源</param>
+        protected virtual DiagnosticsMessage ExecuteBefore(string sql, object parameter, string dataSource = null)
+        {
+            if (!_diagnosticListener.IsEnabled(SqlQueryDiagnosticListenerNames.BeforeExecute))
+                return null;
+            var message = new DiagnosticsMessage
+            {
+                Sql = sql,
+                Parameters = parameter,
+                DataSource = dataSource,
+                OperationTimestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(),
+                Operation = SqlQueryDiagnosticListenerNames.BeforeExecute,
+                DatabaseType = SqlOptions.DatabaseType,
+            };
+            _diagnosticListener.Write(SqlQueryDiagnosticListenerNames.BeforeExecute, message);
+            return message;
+        }
+
+        /// <summary>
+        /// 执行后诊断
+        /// </summary>
+        /// <param name="message">诊断消息</param>
+        protected virtual void ExecuteAfter(DiagnosticsMessage message)
+        {
+            if (message?.OperationTimestamp != null && _diagnosticListener.IsEnabled(SqlQueryDiagnosticListenerNames.AfterExecute))
+            {
+                message.Operation = SqlQueryDiagnosticListenerNames.AfterExecute;
+                message.ElapsedMilliseconds = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() - message.OperationTimestamp.Value;
+                _diagnosticListener.Write(SqlQueryDiagnosticListenerNames.AfterExecute, message);
+            }
+        }
+
+        /// <summary>
+        /// 执行异常诊断
+        /// </summary>
+        /// <param name="message">诊断消息</param>
+        /// <param name="exception">异常</param>
+        protected virtual void ExecuteError(DiagnosticsMessage message, Exception exception)
+        {
+            if (exception != null && message?.OperationTimestamp != null && _diagnosticListener.IsEnabled(SqlQueryDiagnosticListenerNames.ErrorExecute))
+            {
+                message.Exception = exception;
+                message.Operation = SqlQueryDiagnosticListenerNames.ErrorExecute;
+                message.ElapsedMilliseconds = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() - message.OperationTimestamp.Value;
+
+                _diagnosticListener.Write(SqlQueryDiagnosticListenerNames.ErrorExecute, message);
+            }
+        }
+    }
+}

framework/src/Bing.Data.Sql/Bing/Data/Sql/Queries/SqlQueryBase.cs

@@ -4,6 +4,7 @@
 using System.Threading.Tasks;
 using Bing.Data.Sql.Builders;
 using Bing.Data.Sql.Builders.Core;
+using Bing.Data.Sql.Diagnostics;
 using Bing.DependencyInjection;
 using Bing.Helpers;
 using Microsoft.Extensions.Options;
@@ -13,7 +14,7 @@ namespace Bing.Data.Sql.Queries
     /// <summary>
     /// Sql查询对象基类
     /// </summary>
-    public abstract class SqlQueryBase : ISqlQuery, IClauseAccessor, IUnionAccessor, ICteAccessor
+    public abstract partial class SqlQueryBase : ISqlQuery, IClauseAccessor, IUnionAccessor, ICteAccessor
     {
         #region 属性
 
@@ -320,11 +321,26 @@ public abstract Task<PagerList<TResult>> PagerQueryAsync<TResult>(Func<Task<List
         /// <param name="connection">数据库连接</param>
         public TResult Query<TResult>(Func<IDbConnection, string, IReadOnlyDictionary<string, object>, TResult> func, IDbConnection connection = null)
         {
-            var sql = GetSql();
-            WriteTraceLog(sql, Params, GetDebugSql());
-            var result = func(GetConnection(connection), sql, Params);
-            ClearAfterExecution();
-            return result;
+            DiagnosticsMessage message = null;
+            try
+            {
+                var sql = GetSql();
+
+                message = ExecuteBefore(sql, Params);
+
+                WriteTraceLog(sql, Params, GetDebugSql());
+                var result = func(GetConnection(connection), sql, Params);
+                ClearAfterExecution();
+
+                ExecuteAfter(message);
+                return result;
+            }
+            catch (Exception e)
+            {
+                ExecuteError(message, e);
+                throw;
+            }
+            
         }
 
         /// <summary>
@@ -335,11 +351,26 @@ public TResult Query<TResult>(Func<IDbConnection, string, IReadOnlyDictionary<st
         /// <param name="connection">数据库连接</param>
         public async Task<TResult> QueryAsync<TResult>(Func<IDbConnection, string, IReadOnlyDictionary<string, object>, Task<TResult>> func, IDbConnection connection = null)
         {
-            var sql = GetSql();
-            WriteTraceLog(sql, Params, GetDebugSql());
-            var result = await func(GetConnection(connection), sql, Params);
-            ClearAfterExecution();
-            return result;
+            DiagnosticsMessage message = null;
+            try
+            {
+                var sql = GetSql();
+
+                message = ExecuteBefore(sql, Params);
+
+                WriteTraceLog(sql, Params, GetDebugSql());
+                var result = await func(GetConnection(connection), sql, Params);
+                ClearAfterExecution();
+
+                ExecuteAfter(message);
+                return result;
+            }
+            catch (Exception e)
+            {
+                ExecuteError(message, e);
+                throw;
+            }
+            
         }
 
         /// <summary>

framework/src/Bing.Datas.Dapper/Bing/Data/Sql/Queries/SqlQuery.cs

@@ -3,6 +3,7 @@
 using System.Data;
 using System.Linq;
 using System.Threading.Tasks;
+using Bing.Data.Sql.Diagnostics;
 using Bing.Helpers;
 using Bing.Logs;
 using Dapper;
@@ -133,11 +134,25 @@ public override PagerList<TResult> PagerQuery<TResult>(Func<List<TResult>> func,
         /// <param name="connection">数据库连接</param>
         protected int GetCount(IDbConnection connection)
         {
-            var builder = GetCountBuilder();
-            var sql = builder.ToSql();
-            WriteTraceLog(sql, builder.GetParams(), builder.ToDebugSql());
-            var result = GetConnection(connection).ExecuteScalar(sql, builder.GetParams());
-            return Conv.ToInt(result);
+            DiagnosticsMessage message = null;
+            try
+            {
+                var builder = GetCountBuilder();
+                var sql = builder.ToSql();
+
+                message = ExecuteBefore(sql, Params);
+
+                WriteTraceLog(sql, builder.GetParams(), builder.ToDebugSql());
+                var result = GetConnection(connection).ExecuteScalar(sql, builder.GetParams());
+
+                ExecuteAfter(message);
+                return Conv.ToInt(result);
+            }
+            catch (Exception e)
+            {
+                ExecuteError(message, e);
+                throw;
+            }
         }
 
         /// <summary>
@@ -191,11 +206,26 @@ public override async Task<PagerList<TResult>> PagerQueryAsync<TResult>(Func<Tas
         /// <param name="connection">数据库连接</param>
         protected async Task<int> GetCountAsync(IDbConnection connection)
         {
-            var builder = GetCountBuilder();
-            var sql = builder.ToSql();
-            WriteTraceLog(sql, builder.GetParams(), builder.ToDebugSql());
-            var result = await GetConnection(connection).ExecuteScalarAsync(sql, builder.GetParams());
-            return Conv.ToInt(result);
+            DiagnosticsMessage message = null;
+            try
+            {
+                var builder = GetCountBuilder();
+                var sql = builder.ToSql();
+
+                message = ExecuteBefore(sql, Params);
+
+                WriteTraceLog(sql, builder.GetParams(), builder.ToDebugSql());
+                var result = await GetConnection(connection).ExecuteScalarAsync(sql, builder.GetParams());
+
+                ExecuteAfter(message);
+                return Conv.ToInt(result);
+            }
+            catch (Exception e)
+            {
+                ExecuteError(message, e);
+                throw;
+            }
+            
         }
 
         /// <summary>

framework/src/Bing/project.dependency.props

@@ -12,5 +12,7 @@
     <PackageReference Include="Microsoft.Extensions.DependencyModel" Version="$(MicrosoftPackageVersion)" />
     <PackageReference Include="Microsoft.Extensions.Localization" Version="$(MicrosoftPackageVersion)" />
     <PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.1.0" />
+
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="4.5.1" />
   </ItemGroup>
 </Project>