feat: 增加Serilog 写入 Exceptionless 源码

Author: jianxuanbing

framework/src/Bing.Logging.Sinks.Exceptionless/Bing.Logging.Sinks.Exceptionless.csproj

@@ -4,8 +4,4 @@
   <Import Project="project.dependency.props" />
 
   <Import Project="..\..\..\framework.props" />
-
-  <ItemGroup>
-    <PackageReference Include="Serilog.Sinks.Exceptionless" Version="3.1.5" />
-  </ItemGroup>
 </Project>

framework/src/Bing.Logging.Sinks.Exceptionless/Bing/Logging/Sinks/Exceptionless/Internals/LogLevelSwitcher.cs

@@ -23,5 +23,23 @@ internal static class LogLevelSwitcher
                 _ => global::Exceptionless.Logging.LogLevel.Off
             };
         }
+
+        /// <summary>
+        /// 转换日志级别
+        /// </summary>
+        /// <param name="level">Serilog日志级别</param>
+        public static global::Exceptionless.Logging.LogLevel Switch(Serilog.Events.LogEventLevel level)
+        {
+            return level switch
+            {
+                Serilog.Events.LogEventLevel.Verbose => global::Exceptionless.Logging.LogLevel.Trace,
+                Serilog.Events.LogEventLevel.Debug => global::Exceptionless.Logging.LogLevel.Debug,
+                Serilog.Events.LogEventLevel.Information => global::Exceptionless.Logging.LogLevel.Info,
+                Serilog.Events.LogEventLevel.Warning => global::Exceptionless.Logging.LogLevel.Warn,
+                Serilog.Events.LogEventLevel.Error => global::Exceptionless.Logging.LogLevel.Error,
+                Serilog.Events.LogEventLevel.Fatal => global::Exceptionless.Logging.LogLevel.Fatal,
+                _ => global::Exceptionless.Logging.LogLevel.Other
+            };
+        }
     }
 }

framework/src/Bing.Logging.Sinks.Exceptionless/Serilog/LoggerSinkConfigurationExtensions.cs

@@ -0,0 +1,84 @@
+using System;
+using Exceptionless;
+using Serilog.Configuration;
+using Serilog.Events;
+using Serilog.Sinks.Exceptionless;
+
+namespace Serilog
+{
+    /// <summary>
+    /// 日志接收器配置(<see cref="LoggerSinkConfiguration"/>) 扩展
+    /// </summary>
+    public static partial class LoggerSinkConfigurationExtensions
+    {
+        /// <summary>
+        /// 创建一个基于Exceptionless的日志接收器
+        /// </summary>
+        /// <param name="loggerSinkConfiguration">日志接收器配置</param>
+        /// <param name="apiKey">API密钥</param>
+        /// <param name="additionalOperation">附加信息操作函数</param>
+        /// <param name="includeProperties">是否包含属性列表</param>
+        /// <param name="restrictedToMinimumLevel">最小日志事件级别</param>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static LoggerConfiguration Exceptionless(
+            this LoggerSinkConfiguration loggerSinkConfiguration,
+            string apiKey, 
+            Func<EventBuilder, EventBuilder> additionalOperation = null, 
+            bool includeProperties = true,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum)
+        {
+            if (loggerSinkConfiguration == null)
+                throw new ArgumentNullException(nameof(loggerSinkConfiguration));
+            if (apiKey == null)
+                throw new ArgumentNullException(nameof(apiKey));
+            return loggerSinkConfiguration.Sink(new ExceptionlessSink(apiKey, null, null, additionalOperation, includeProperties), restrictedToMinimumLevel);
+        }
+
+        /// <summary>
+        /// 创建一个基于Exceptionless的日志接收器
+        /// </summary>
+        /// <param name="loggerSinkConfiguration">日志接收器配置</param>
+        /// <param name="serverUrl">Exceptionless服务器地址</param>
+        /// <param name="apiKey">API密钥</param>
+        /// <param name="defaultTags">默认标签数组</param>
+        /// <param name="additionalOperation">附加信息操作函数</param>
+        /// <param name="includeProperties">是否包含属性列表</param>
+        /// <param name="restrictedToMinimumLevel">最小日志事件级别</param>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static LoggerConfiguration Exceptionless(
+            this LoggerSinkConfiguration loggerSinkConfiguration,
+            string apiKey,
+            string serverUrl = null,
+            string[] defaultTags = null,
+            Func<EventBuilder, EventBuilder> additionalOperation = null,
+            bool includeProperties = true,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum)
+        {
+            if (loggerSinkConfiguration == null)
+                throw new ArgumentNullException(nameof(loggerSinkConfiguration));
+            if (apiKey == null)
+                throw new ArgumentNullException(nameof(apiKey));
+            return loggerSinkConfiguration.Sink(new ExceptionlessSink(apiKey, serverUrl, defaultTags, additionalOperation, includeProperties), restrictedToMinimumLevel);
+        }
+
+        /// <summary>
+        /// 创建一个基于Exceptionless的日志接收器
+        /// </summary>
+        /// <param name="loggerSinkConfiguration">日志接收器配置</param>
+        /// <param name="additionalOperation">附加信息操作函数</param>
+        /// <param name="includeProperties">是否包含属性列表</param>
+        /// <param name="restrictedToMinimumLevel">最小日志事件级别</param>
+        /// <param name="client">Exceptionless客户端</param>
+        public static LoggerConfiguration Exceptionless(
+            this LoggerSinkConfiguration loggerSinkConfiguration,
+            Func<EventBuilder, EventBuilder> additionalOperation = null,
+            bool includeProperties = true,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            ExceptionlessClient client = null)
+        {
+            if (loggerSinkConfiguration == null)
+                throw new ArgumentNullException(nameof(loggerSinkConfiguration));
+            return loggerSinkConfiguration.Sink(new ExceptionlessSink(additionalOperation, includeProperties, client));
+        }
+    }
+}

framework/src/Bing.Logging.Sinks.Exceptionless/Serilog/Sinks/Exceptionless/ExceptionlessClientExtensions.cs

@@ -0,0 +1,97 @@
+using System.Collections.Generic;
+using Bing.Logging.Sinks.Exceptionless.Internals;
+using Exceptionless;
+using Serilog.Core;
+using Serilog.Events;
+
+namespace Serilog.Sinks.Exceptionless
+{
+    /// <summary>
+    /// Exceptionless客户端(<see cref="ExceptionlessClient"/>) 扩展
+    /// </summary>
+    public static class ExceptionlessClientExtensions
+    {
+        /// <summary>
+        /// 从Serilog日志事件创建事件构建器
+        /// </summary>
+        /// <param name="client">Exceptionless客户端</param>
+        /// <param name="log">Serilog日志事件</param>
+        public static EventBuilder CreateFromLogEvent(this ExceptionlessClient client, LogEvent log)
+        {
+            var message = log.RenderMessage();
+            
+            var builder = log.Exception != null
+                ? client.CreateException(log.Exception)
+                : client.CreateLog(log.GetSource(), message, LogLevelSwitcher.Switch(log.Level));
+
+            builder.Target.Date = log.Timestamp;
+            if (log.Level == LogEventLevel.Fatal)
+                builder.MarkAsCritical();
+
+            if (!string.IsNullOrWhiteSpace(message))
+                builder.SetMessage(message);
+
+            return builder;
+        }
+
+        /// <summary>
+        /// 从Serilog日志事件提交
+        /// </summary>
+        /// <param name="client">Exceptionless客户端</param>
+        /// <param name="log">Serilog日志事件</param>
+        public static void SubmitFromLogEvent(this ExceptionlessClient client, LogEvent log) => CreateFromLogEvent(client,log).Submit();
+
+        /// <summary>
+        /// 获取来源
+        /// </summary>
+        /// <param name="log">日志事件</param>
+        internal static string GetSource(this LogEvent log)
+        {
+            if (log.Properties.TryGetValue(Constants.SourceContextPropertyName, out var value))
+                return value.FlattenProperties()?.ToString();
+            return null;
+        }
+
+        /// <summary>
+        /// 展开属性
+        /// <para>
+        /// 删除了<see cref="LogEventPropertyValue"/>实现的结构化。
+        /// </para>
+        /// </summary>
+        /// <param name="value">日志事件属性值</param>
+        internal static object FlattenProperties(this LogEventPropertyValue value)
+        {
+            if (value == null)
+                return null;
+
+            if (value is ScalarValue scalar)
+                return scalar.Value;
+
+            if (value is SequenceValue sequence)
+            {
+                var flattenedProperties = new List<object>(sequence.Elements.Count);
+                foreach (var element in sequence.Elements) 
+                    flattenedProperties.Add(element.FlattenProperties());
+                return flattenedProperties;
+            }
+
+            if (value is StructureValue structure)
+            {
+                var flattenedProperties = new Dictionary<string, object>(structure.Properties.Count);
+                foreach (var property in structure.Properties)
+                    flattenedProperties.Add(property.Name, property.Value.FlattenProperties());
+                return flattenedProperties;
+            }
+
+            if (value is DictionaryValue dictionary)
+            {
+                var flattenedProperties = new Dictionary<object, object>(dictionary.Elements.Count);
+                foreach (var element in dictionary.Elements)
+                    flattenedProperties.Add(element.Key.Value, element.Value.FlattenProperties());
+                return flattenedProperties;
+            }
+
+            return value;
+        }
+    }
+}

framework/src/Bing.Logging.Sinks.Exceptionless/Serilog/Sinks/Exceptionless/ExceptionlessSink.cs

@@ -0,0 +1,147 @@
+using System;
+using System.Collections.Generic;
+using Bing.Logging.Sinks.Exceptionless.Internals;
+using Exceptionless;
+using Exceptionless.Dependency;
+using Exceptionless.Logging;
+using Exceptionless.Models;
+using Exceptionless.Models.Data;
+using Serilog.Core;
+using Serilog.Events;
+
+namespace Serilog.Sinks.Exceptionless
+{
+    /// <summary>
+    /// Exceptionless 接收器
+    /// </summary>
+    public class ExceptionlessSink : ILogEventSink, IDisposable
+    {
+        /// <summary>
+        /// 默认标签数组
+        /// </summary>
+        private readonly string[] _defaultTags;
+
+        /// <summary>
+        /// 附加信息操作函数
+        /// </summary>
+        private readonly Func<EventBuilder, EventBuilder> _additionalOperation;
+
+        /// <summary>
+        /// 是否包含属性列表
+        /// </summary>
+        private readonly bool _includeProperties;
+
+        /// <summary>
+        /// Exceptionless 客户端
+        /// </summary>
+        private readonly ExceptionlessClient _client;
+
+        /// <summary>
+        /// 初始化一个<see cref="ExceptionlessSink"/>类型的实例
+        /// </summary>
+        /// <param name="apiKey">API密钥</param>
+        /// <param name="serverUrl">Exceptionless服务器地址</param>
+        /// <param name="defaultTags">默认标签数组</param>
+        /// <param name="additionalOperation">附加信息操作函数</param>
+        /// <param name="includeProperties">是否包含属性列表</param>
+        public ExceptionlessSink(
+            string apiKey, 
+            string serverUrl = null, 
+            string[] defaultTags = null, 
+            Func<EventBuilder, EventBuilder> additionalOperation = null, 
+            bool includeProperties = true)
+        {
+            if (apiKey == null)
+                throw new ArgumentNullException(nameof(apiKey));
+            _client = new ExceptionlessClient(config =>
+            {
+                if (!string.IsNullOrEmpty(apiKey) && apiKey != "API_KEY_HERE")
+                    config.ApiKey = apiKey;
+                if (!string.IsNullOrEmpty(serverUrl))
+                    config.ServerUrl = serverUrl;
+                config.UseInMemoryStorage();
+                config.UseLogger(new SelfLogLogger());
+            });
+            _defaultTags = defaultTags;
+            _additionalOperation = additionalOperation;
+            _includeProperties = includeProperties;
+        }
+
+        /// <summary>
+        /// 初始化一个<see cref="ExceptionlessSink"/>类型的实例
+        /// </summary>
+        /// <param name="additionalOperation">附加信息操作函数</param>
+        /// <param name="includeProperties">是否包含属性列表</param>
+        /// <param name="client">Exceptionless客户端</param>
+        public ExceptionlessSink(
+            Func<EventBuilder, EventBuilder> additionalOperation = null,
+            bool includeProperties = true,
+            ExceptionlessClient client = null)
+        {
+            _additionalOperation = additionalOperation;
+            _includeProperties = includeProperties;
+            _client = client ?? ExceptionlessClient.Default;
+            if (_client.Configuration.Resolver.HasDefaultRegistration<IExceptionlessLog, NullExceptionlessLog>())
+                _client.Configuration.UseLogger(new SelfLogLogger());
+        }
+
+        /// <summary>提交.</summary>
+        /// <param name="logEvent">日志事件</param>
+        public void Emit(LogEvent logEvent)
+        {
+            if (logEvent == null || _client.Configuration.IsValid)
+                return;
+            var minLogLevel = _client.Configuration.Settings.GetMinLogLevel(logEvent.GetSource());
+            if (LogLevelSwitcher.Switch(logEvent.Level) < minLogLevel)
+                return;
+
+            var builder = _client
+                .CreateFromLogEvent(logEvent)
+                .AddTags(_defaultTags);
+
+            if (_includeProperties && logEvent.Properties != null)
+            {
+                foreach (var property in logEvent.Properties)
+                {
+                    switch (property.Key)
+                    {
+                        case Constants.SourceContextPropertyName:
+                            continue;
+                        case Event.KnownDataKeys.UserInfo when property.Value is StructureValue uis && string.Equals(nameof(UserInfo), uis.TypeTag):
+                            var userInfo = uis.FlattenProperties() as Dictionary<string, object>;
+                            if (userInfo is null)
+                                continue;
+                            // 忽略数据属性
+                            var identity = userInfo[nameof(UserInfo.Identity)] as string;
+                            var name = userInfo[nameof(UserInfo.Name)] as string;
+                            if (!string.IsNullOrWhiteSpace(identity) || !string.IsNullOrWhiteSpace(name))
+                                builder.SetUserIdentity(identity, name);
+                            break;
+                        
+                        case Event.KnownDataKeys.UserDescription when property.Value is StructureValue uds && string.Equals(nameof(UserDescription), uds.TypeTag):
+                            var userDescription = uds.FlattenProperties() as Dictionary<string, object>;
+                            if (userDescription is null)
+                                continue;
+                            // 忽略数据属性
+                            var emailAddress = userDescription[nameof(UserDescription.EmailAddress)] as string;
+                            var description = userDescription[nameof(UserDescription.Description)] as string;
+                            if (!string.IsNullOrWhiteSpace(emailAddress) || !string.IsNullOrWhiteSpace(description))
+                                builder.SetUserDescription(emailAddress, description);
+                            break;
+                        default:
+                            builder.SetProperty(property.Key, property.Value.FlattenProperties());
+                            break;
+                    }
+                }
+            }
+
+            _additionalOperation?.Invoke(builder);
+            builder.Submit();
+        }
+
+        /// <summary>
+        /// 释放资源
+        /// </summary>
+        public void Dispose() => _client?.ProcessQueue();
+    }
+}